VPC Prefix

Retrieve all VPC Prefixes

Changed on

Retrieve all VPC Prefixes for the org

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

get/v2/org/{org}/nico/vpc-prefix

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/vpc-prefix
  • Auth
    HTTP bearer

Query parameters

siteIdstring uuid

Filter VPC Prefixes by Site, required if the vpcId query parameter is not specified

vpcIdstring uuid

Filter VPC Prefixes by VPC

statusstring

Filter VPC Prefixes by Status

querystring

Search for matches across all VPC Prefixes. Input will be matched against name and status fields

includeRelation'VPC' | 'Tenant' | 'IPBlock'

Related entity to expand

includeUsageStatsboolean

When true, each VPC Prefix with IPv4 includes IPv4 usage statistics using the same structure as IP Block usage. Usage is derived from associated Ethernet interfaces and their IPv4 addresses. IP usage counts two addresses per interface, while prefix usage counts each distinct /31 containing an assigned IPv4 address.

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'NAME_ASC' | 'NAME_DESC' | 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query

Response

OK

idstring uuid

Unique UUID v4 identifier for the VPCPrefix

namestring

Name of the VPC Prefix

siteIdstring uuid

ID of the Site the VPC Prefix belongs to

vpcIdstring uuid

ID of the VPC the VPC Prefix belongs to

ipBlockIdstring uuid nullable

ID of the IP Block that contains the prefix of the VPC Prefix

prefixstring nullable

The network prefix including prefix length in CIDR notation

prefixLengthinteger

Length of the returned prefix. A VPC Prefix reported by a Site may fall outside the bounds for REST create requests.

status'Provisioning' | 'Ready' | 'Deleting' | 'Error'

Status values for VPC Prefix objects

createdstring date-time

Date and time when the VPC Prefix was created

updatedstring date-time

Date and time when the VPC Prefix was updated

Example response

[
  {
    "id": "0c03ba01-d86b-4a57-a41e-cc359b380a6f",
    "name": "east-vpc-traffic-net",
    "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
    "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    "prefix": "192.168.1.0/24",
    "ipBlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    "prefixLength": 24,
    "status": "Ready",
    "usageStats": {
      "availableIPs": 256,
      "acquiredIPs": 2,
      "availablePrefixes": [
        "192.168.1.0/28",
        "192.168.1.16/30",
        "192.168.1.24/29",
        "192.168.1.32/27",
        "192.168.1.64/26",
        "192.168.1.128/25"
      ],
      "availableSmallestPrefixes": 63,
      "acquiredPrefixes": 1
    },
    "statusHistory": [
      {
        "status": "Ready",
        "message": "Received VPC prefix creation request, ready",
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]

Changes

  • 273aadbf1c41Revision changes
    • breaking

      the // response's property format changed from uuid to no format for status

    • info

      removed the Deleted enum value from the / response property for the response status

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status