API ReferenceVPC Prefix

Retrieve all VPC Prefixes

View as Markdown

Retrieve all VPC Prefixes for the org

Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

Authentication

AuthorizationBearer
``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired
Name of the Org

Query parameters

siteIdstringOptionalformat: "uuid"
Filter VPC Prefixes by Site, required if the vpcId query parameter is not specified
vpcIdstringOptionalformat: "uuid"
Filter VPC Prefixes by VPC
statusstringOptional
Filter VPC Prefixes by Status
querystringOptional
Search for matches across all VPC Prefixes. Input will be matched against name and status fields
includeRelationenumOptional
Related entity to expand
Allowed values:
includeUsageStatsbooleanOptional

When true, each VPC Prefix object includes usage statistics using the same structure as IP Block usage. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a VPC Prefix consumes a /31 prefix.

pageNumberintegerOptional>=1Defaults to 1
Page number for pagination query
pageSizeintegerOptional1-100
Page size for pagination query
orderByenumOptional
Ordering for pagination query

Response headers

X-Paginationstring
Pagination result in JSON format

Response

OK
idstringRead-onlyformat: "uuid"
Unique UUID v4 identifier for the VPCPrefix
namestring2-256 characters
Name of the VPC Prefix
siteIdstringformat: "uuid"
ID of the Site the VPC Prefix belongs to
vpcIdstringformat: "uuid"
ID of the VPC the VPC Prefix belongs to
ipBlockIdstring or nullformat: "uuid"
ID of the IP Block that contains the prefix of the VPC Prefix
prefixstring or null
The network prefix including prefix length in CIDR notation
prefixLengthinteger8-31
Length of the prefix. Valid range is 8 to 31, and max usable value depends on prefix length of parent IP Block.
statusenum
Status of the VPC Prefix
usageStatsobject

Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a VPC Prefix consumes a /31 prefix.

statusHistorylist of objectsRead-only
Details of 20 most recent status changes
createddatetimeRead-only
Date and time when the VPC Prefix was created
updateddatetimeRead-only
Date and time when the VPC Prefix was updated

Errors

403
Forbidden Error