Create IP Block

POST

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/ipblock

POST

/v2/org/:org/nico/ipblock

curl -X POST https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/ipblock \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Public Network Overlay for Site SJC4",
  "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  "routingType": "Public",
  "prefix": "202.168.1.0",
  "prefixLength": 24,
  "protocolVersion": "IPv4",
  "description": "This is the primary IP overlay for SJC4. All IPs are publicly routable"
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Public Network Overlay for Site SJC4",
  "description": "This is the primary IP overlay for SJC4. All IPs are publicly routable",
  "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
  "tenantId": null,
  "routingType": "Public",
  "prefix": "202.168.1.0",
  "prefixLength": 24,
  "protocolVersion": "IPv4",
  "status": "Pending",
  "statusHistory": [
    {
      "status": "Pending",
      "message": "Request received, pending processing",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}

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. DatacenterOnly creation also returns 409 when another Site fabric IP Block update holds the shared Site lock, including another DatacenterOnly create or Site Config import. Retry the request.

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. `DatacenterOnly` creation also returns 409 when another Site fabric IP Block update holds the shared Site lock, including another `DatacenterOnly` 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

``` 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

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

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

routingTypeenumOptional

RoutingType of the IP Block

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

usageStatsobjectOptional

Usage summary from IPAM for the IP Block

statusenumOptional

Status of the IP Block

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