API ReferenceVPC

Update VPC

View as Markdown

Update an existing VPC

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

Path parameters

orgstringRequired
Name of the Org
vpcIdstringRequiredformat: "uuid"
ID of the VPC

Request

This endpoint expects an object.
namestring or nullOptional2-256 characters
Updated name of the VPC
descriptionstring or nullOptional
Updated description of the VPC
networkSecurityGroupIdstring or nullOptional
ID of the Network Security Group to attach to the VPC
nvLinkLogicalPartitionIdstring or nullOptionalformat: "uuid"
ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to. Can only be updated if VPC currently has no active Instances
labelsmap from strings to stringsOptional

Update labels of the VPC. Up to 10 key-value pairs can be specified. The labels will be replaced with the labels sent in the request. Any labels not included in the request will be removed. To retain existing labels, fetch them first and include them in this request.

Response

OK
idstringRead-onlyformat: "uuid"
ID of the VPC
namestring2-256 characters
Name of the VPC
descriptionstring or null
Description of the VPC, can be empty
orgstringRead-only
Organization the VPC belongs to
tenantIdstringRead-onlyformat: "uuid"
ID of the Tenant the VPC belongs to
siteIdstringformat: "uuid"
ID of the Site the VPC belongs to
controllerVpcIdstring or nullformat: "uuid"
Legacy attribute, contains the same value as ID
networkVirtualizationTypeenum

Network virtualization type of the VPC. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode); their interfaces are bound to underlay (HostInband) network segments and NICo does not drive their data plane.

routingProfilestring or null3-64 characters

Routing profile type for the VPC. Populated when Site has Native Networking enabled and network virtualization type is FNN.

requestedVniinteger or nullRead-only1-65535
Explicitly requested VNI for the VPC if one was requested at creation time
vniinteger or nullRead-only1-65535
Active VNI assigned to the VPC
networkSecurityGroupIdstring or null
ID of the Network Security Group attached to the VPC
networkSecurityGroupPropagationDetailsobject
Propagation details for the attached Network Security Group
nvLinkLogicalPartitionIdstring or nullformat: "uuid"
ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to
labelsmap from strings to strings

String key-value pairs describing VPC labels

statusenum
Status of the VPC
statusHistorylist of objectsRead-only
History of status changes for the VPC
createddatetimeRead-only

Date/time when VPC was created

updateddatetimeRead-only

Date/time when VPC was last updated

Errors

400
Bad Request Error
403
Forbidden Error