Skip to navigation
API ReferenceVPC Prefix

Create VPC Prefix

View as Markdown

Create a VPC Prefix for the org.

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

The VPC must be Ready and use FNN, and its Site must be Registered. ipBlockId must identify a Ready tenant IP Block at the VPC’s Site. The selected IP Block determines whether the VPC Prefix uses IPv4 or IPv6.

Specify exactly one allocation selector. prefixLength lets NICo IPAM choose an available CIDR. prefix requests an exact, network-aligned CIDR contained by the selected IP Block. Both modes share the same allocation state; an unavailable explicit CIDR is rejected rather than replaced. A prefix equal to its IP Block reserves the whole block.

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

Request

This endpoint expects an object.
VpcPrefixAutomaticCreateRequestobjectRequired
OR
VpcPrefixExplicitCreateRequestobjectRequired

Response

Created
idstringOptionalRead-onlyformat: "uuid"
Unique UUID v4 identifier for the VPCPrefix
namestringOptional2-256 characters
Name of the VPC Prefix
siteIdstringOptionalformat: "uuid"
ID of the Site the VPC Prefix belongs to
vpcIdstringOptionalformat: "uuid"
ID of the VPC the VPC Prefix belongs to
ipBlockIdstring or nullOptionalformat: "uuid"
ID of the IP Block that contains the prefix of the VPC Prefix
prefixstring or nullOptional
The network prefix including prefix length in CIDR notation
prefixLengthintegerOptional
Length of the returned prefix. A VPC Prefix reported by a Site may fall outside the bounds for REST create requests.
statusenumOptional
Status of the VPC Prefix
Allowed values:
usageStatsobjectOptional

Present when query parameter includeUsageStats=true and the VPC Prefix has IPv4. This statistic reports IPv4 usage only. IP usage counts two addresses per associated Ethernet interface, while prefix usage counts each distinct /31 containing an assigned IPv4 address.

statusHistorylist of objectsOptionalRead-only
Details of 20 most recent status changes
createddatetimeOptionalRead-only
Date and time when the VPC Prefix was created
updateddatetimeOptionalRead-only
Date and time when the VPC Prefix was updated

Errors

400
Bad Request Error
403
Forbidden Error