Skip to navigation
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

A non-empty powerResourceGroup requires the Site’s dpsPowerManagement capability to be true; otherwise the request returns 412. Omission or null preserves the current association, while an empty string clears it even when DPS power management is disabled.

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
routingProfileOverridesobject or nullOptional

Replaces the current inline routing-profile definition when present. Requires TargetedInstanceCreation to be effective for the Tenant at the VPC’s Site. Omission or null preserves the current definition. An empty object restores inheritance for every property; a partial object replaces the previous definition and inherits its omitted properties from the named profile.

powerResourceGroupstring or nullOptional

Power resource group to associate with the VPC. A non-empty value requires the Site’s dpsPowerManagement capability to be true. Omission or null preserves the current association; an empty string clears it when DPS power management is disabled.

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
idstringOptionalRead-onlyformat: "uuid"
ID of the VPC
namestringOptional2-256 characters
Name of the VPC
descriptionstring or nullOptional
Description of the VPC, can be empty
orgstringOptionalRead-only
Organization the VPC belongs to
tenantIdstringOptionalRead-onlyformat: "uuid"
ID of the Tenant the VPC belongs to
siteIdstringOptionalformat: "uuid"
ID of the Site the VPC belongs to
controllerVpcIdstring or nullOptionalformat: "uuid"
Legacy attribute, contains the same value as ID
networkVirtualizationTypeenumOptional

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.

Allowed values:
slaacEnabledbooleanOptionalRead-only

Whether this VPC uses SLAAC allocation mode for instance IPv6 interfaces. When true, Core allocates a /64 to each interface that includes IPv6 and retains the prefix without assigning a concrete IPv6 host address. This value is fixed when the VPC is created. The DPU sends router advertisements (RAs) on routed FNN interfaces. With SLAAC enabled, it sends them only when the interface prefix is exactly a /64.

routingProfilestring or nullOptional1-64 characters

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

powerResourceGroupstring or nullOptional
External power provisioning resource group associated with the VPC.
routingProfileOverridesobject or nullOptional

Routing-profile properties set directly on the VPC. Unset properties inherit from the named routing profile.

effectiveRoutingProfileobjectOptional
Fully resolved routing profile last reported by Core for the VPC. This property is included only when the requesting Tenant has effective TargetedInstanceCreation permission for the VPC's Site.
requestedVniinteger or nullOptionalRead-only1-16777215
Explicitly requested VNI for the VPC if one was requested at creation time
vniinteger or nullOptionalRead-only1-16777215
Active VNI assigned to the VPC
networkSecurityGroupIdstring or nullOptional
ID of the Network Security Group attached to the VPC
networkSecurityGroupPropagationDetailsobject or nullOptional
Propagation details for the attached Network Security Group. Null when no propagation details are available, including when no Network Security Group is attached
nvLinkLogicalPartitionIdstring or nullOptionalformat: "uuid"
ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to
labelsmap from strings to stringsOptional

String key-value pairs describing VPC labels

statusenumOptional
Status of the VPC
Allowed values:
statusHistorylist of objectsOptionalRead-only
History of status changes for the VPC
createddatetimeOptionalRead-only

Date/time when VPC was created

updateddatetimeOptionalRead-only

Date/time when VPC was last updated

Errors

400
Bad Request Error
403
Forbidden Error
409
Conflict Error
412
Precondition Failed Error