API ReferenceVPC Prefix

Create VPC Prefix

View as Markdown

Create a VPC Prefix for the org.

Org must have a Tenant entity. User must have FORGE_TENANT_ADMIN authorization role.

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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

Request

This endpoint expects an object.
namestringRequired2-256 characters
Human readable name for the VPC Prefix
vpcIdstringRequiredformat: "uuid"
ID of the VPC
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.
ipBlockIdstringOptionalformat: "uuid"

Response

Created
idstringRead-onlyformat: "uuid"
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
tenantIdstringformat: "uuid"
ID of the Tenant 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
Allowed values:
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