API ReferenceVPC

Update VPC

View as Markdown

Update an existing VPC

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
vpcIdstringRequired

Request

This endpoint expects an object.
namestringOptional2-256 characters
Updated name of the VPC
descriptionstringOptional
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 entirely replaced by those sent in the request. Any labels not included in the request will be removed. To retain existing labels, first fetch them and include them along with this request.

Response

OK
idstringRead-onlyformat: "uuid"
ID of the VPC
namestring2-256 characters
Name of the VPC
descriptionstring
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
Allowed values:
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