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

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

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.

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

idstringRead-onlyformat: "uuid"

Unique UUID v4 identifier for the IP Block

namestring2-256 characters

Name of the IP Block

descriptionstring or null

Description of the IP Block

siteIdstringformat: "uuid"

ID of the Site

infrastructureProviderIdstringformat: "uuid"

ID of the Infrastructure Provider

tenantIdstring or nullformat: "uuid"

ID of the Tenant

routingTypeenum

RoutingType of the IP Block

prefixstring

Either IPv4 or IPv6 address

prefixLengthinteger

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

protocolVersionenum

Version of the ip network IPv4 or IPv6

usageStatsobject

Usage summary from IPAM for the IP Block

statusenum

Status of the IP Block

statusHistorylist of objects

Chronological status history for the IP Block

createddatetimeRead-only

Date/time when the Ip Block was created

updateddatetimeRead-only

Date/time when the Ip Block was last updated

Errors

400

Bad Request Error

403

Forbidden Error