Update VPC Prefix

PATCH

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

PATCH

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

curl -X PATCH https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/vpc-prefix/vpcPrefixId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "east-vpc-traffic-net"
}'

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

Update an existing VPC Prefix

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

vpcPrefixIdstringRequiredformat: "uuid"

ID of the VPC Prefix

Request

This endpoint expects an object.

namestringRequired2-256 characters

Name of the VPCPrefix

Response

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

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