prefix DataStream¶
prefix DataStream contains summarized IPAM Prefix state
Fields¶
| Name | Type | Description |
|---|---|---|
| id | String | Prefix id |
| change_id | String | Record's Change Id |
| name | String | Prefix name |
| prefix | String | Prefix (i.e. 192.168.0.0/24) |
| vpn_id | String | VPN ID |
| afi | String | Prefix address family: |
• ipv4 | ||
• ipv6 | ||
| description | String | Prefix textual description |
| tags | Array of String | Prefix tags |
| state | Object | Prefix workflow state |
| id | String | State id |
| name | String | State name |
| workflow | Object | Prefix workflow |
| id | String | Workflow id |
| name | String | Workflow name |
| allocated_till | Datetime | Workflow state deadline |
| profile | Object | Prefix Profile |
| id | String | Prefix Profile id |
| name | String | Prefix Profile name |
| project | Object | Prefix Project |
| id | String | Project id |
| name | String | Project name |
| vrf | Object | Prefix VRF |
| id | String | VRF id |
| name | String | VRF name |
| asn | Object | Prefix Autonomous System (AS) |
| id | String | AS id |
| name | String | AS name |
| asn | String | AS number (like AS65000) |
| source | String | VRF Learning source: |
• M - Manual | ||
• i - Interface | ||
• w - Whois | ||
• n - Neighbor |
Access¶
API Key with datastream:prefix permissions required.