Sign in

v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
VPC Prefix

Create VPC Prefix

Create a VPC Prefix for the org.

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

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

Request body

namestring required

Human readable name for the VPC Prefix

vpcIdstring uuid required

ID of the VPC

ipBlockIdstring uuid required

ID of the IP Block to allocate the VPC Prefix from

prefixLengthinteger required

Prefix length for the VPC Prefix. Valid range is 8 to 31, and max usable value depends on prefix length of parent IP Block.

Example request

{
  "name": "east-vpc-traffic-net",
  "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
  "ipBlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
  "prefixLength": 20
}

Response

Created

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"
}