Sign in
VPC Prefix

Retrieve VPC Prefix

Retrieve a specific VPC Prefix

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

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

Query parameters

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

Related entity to expand

includeUsageStatsboolean

When true, a 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.

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 prefix. Valid range is 8 to 31, and max usable value depends on prefix length of parent IP Block.

status'Provisioning' | 'Ready' | 'Deleting' | 'Deleted' | '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

Changed in 6 of the 95 revisions of this API.454

  • 484497856a944See the full diff
    • ▲

      the / response's property format changed from int64 to uint64 for status

      response-property-type-changed

    • ▲

      the / response's property format changed from int64 to uint64 for status

      response-property-type-changed

    • ▲

      the / response's property format changed from int64 to uint64 for status

      response-property-type-changed

    • ▲

      the / response's property format changed from int64 to uint64 for status

      response-property-type-changed

  • 510d92330e3d2See the full diff
    • ●

      added the new Deleted enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new Provisioning enum value to the response property for the response status

      response-property-enum-value-added

  • bc7cf73fe6041See the full diff
    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b078e63260c12See the full diff
    • ○

      added the new optional query request parameter includeUsageStats

      new-optional-request-parameter

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • ffa0635230582See the full diff
    • ●

      deleted the query request parameter includeUsageStats

      request-parameter-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f20872e0979a2See the full diff
    • ○

      added the new optional query request parameter includeUsageStats

      new-optional-request-parameter

    • ○

      added the optional property to the response with the status

      response-optional-property-added