Skip to navigation
API ReferenceIP Block

Create IP Block

View as Markdown

Create an IP block for the org.

Only Infrastructure Providers can create a root IP Block. User must have authorization role with PROVIDER_ADMIN suffix.

Tenant IP Blocks are created via Allocation.

A conflicting name or address range returns 409. A range conflicts when it overlaps any root IP Block of the Site, whatever its routing type. Creation also returns 409 when another Site fabric IP Block update holds the shared Site lock, including another create or Site Config import. Retry the request.

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.
namestringRequired2-256 characters
Name of the IP Block
siteIdstringRequiredformat: "uuid"
ID of the site
routingTypeenumRequired
Routing type of the IP Block
Allowed values:
prefixstringRequired
Either IPv4 or IPv6 address
prefixLengthintegerRequired

Min: 1, Max: 32 for IPv4, 128 for IPv6

protocolVersionenumRequired
Version of the ip network ipv4 or ipv6
Allowed values:
descriptionstring or nullOptional
Description of the IP Block

Response

Created
idstringOptionalRead-onlyformat: "uuid"
Unique UUID v4 identifier for the IP Block
namestringOptional2-256 characters
Name of the IP Block
descriptionstring or nullOptional
Description of the IP Block
siteIdstringOptionalformat: "uuid"
ID of the Site
infrastructureProviderIdstringOptionalformat: "uuid"
ID of the Infrastructure Provider
tenantIdstring or nullOptionalformat: "uuid"
ID of the Tenant
managedbooleanOptionalRead-only

Always present. True for Site fabric/root/overlay blocks and blocks allocated to a Tenant by the Infrastructure Provider; false for blocks created by a Tenant. This classification is independent of the Tenant assignment and cannot be changed by clients.

routingTypeenumOptional
RoutingType of the IP Block
Allowed values:
prefixstringOptional
Either IPv4 or IPv6 address
prefixLengthintegerOptional

Min: 1, Max: 32 for ipv4, 128 for ipv6

protocolVersionenumOptional
Version of the ip network IPv4 or IPv6
Allowed values:
usageStatsobjectOptional
Usage summary from IPAM for the IP Block
statusenumOptional
Status of the IP Block
Allowed values:
statusHistorylist of objectsOptional
Chronological status history for the IP Block
createddatetimeOptionalRead-only

Date/time when the Ip Block was created

updateddatetimeOptionalRead-only

Date/time when the Ip Block was last updated

Errors

400
Bad Request Error
403
Forbidden Error
409
Conflict Error