Create VPC Prefix

POST

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

POST

/v2/org/:org/nico/vpc-prefix

$ curl -X POST https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/vpc-prefix \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "east-vpc-traffic-net",
>   "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
>   "ipBlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
>   "prefixLength": 20
> }'

1 {
2   "id": "0c03ba01-d86b-4a57-a41e-cc359b380a6f",
3   "name": "east-vpc-traffic-net",
4   "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
5   "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
6   "ipBlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
7   "prefix": "192.168.1.0/24",
8   "prefixLength": 24,
9   "status": "Ready",
10   "usageStats": {
11     "availableIPs": 256,
12     "acquiredIPs": 2,
13     "availablePrefixes": [
14       "192.168.1.0/28",
15       "192.168.1.16/30",
16       "192.168.1.24/29",
17       "192.168.1.32/27",
18       "192.168.1.64/26",
19       "192.168.1.128/25"
20     ],
21     "availableSmallestPrefixes": 63,
22     "acquiredPrefixes": 1
23   },
24   "statusHistory": [
25     {
26       "status": "Ready",
27       "message": "Received VPC prefix creation request, ready",
28       "created": "2019-08-24T14:15:22Z",
29       "updated": "2019-08-24T14:15:22Z"
30     }
31   ],
32   "created": "2019-08-24T14:15:22Z",
33   "updated": "2019-08-24T14:15:22Z"
34 }

Create a VPC Prefix for the org.

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

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

Human readable name for the VPC Prefix

vpcIdstringRequiredformat: "uuid"

ID of the VPC

ipBlockIdstringRequiredformat: "uuid"

ID of the IP Block to allocate the VPC Prefix from

prefixLengthintegerRequired8-31

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

Response

Created

idstringRead-onlyformat: "uuid"

Unique UUID v4 identifier for the VPCPrefix

namestring2-256 characters

Name of the VPC Prefix

siteIdstringformat: "uuid"

ID of the Site the VPC Prefix belongs to

vpcIdstringformat: "uuid"

ID of the VPC the VPC Prefix belongs to

ipBlockIdstring or nullformat: "uuid"

ID of the IP Block that contains the prefix of the VPC Prefix

prefixstring or null

The network prefix including prefix length in CIDR notation

prefixLengthinteger8-31

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

statusenum

Status of the VPC Prefix

usageStatsobject

Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a VPC Prefix consumes a /31 prefix.

statusHistorylist of objectsRead-only

Details of 20 most recent status changes

createddatetimeRead-only

Date and time when the VPC Prefix was created

updateddatetimeRead-only

Date and time when the VPC Prefix was updated

Errors

400

Bad Request Error

403

Forbidden Error