Update a GPU VM

​

Update GPU VM metadata (name, resource group, SSH key association, username). Requires GPU feature to be enabled.

Path Parameters
  • id
    Type: stringFormat: uuid
    required

    The GPU VM ID

Body
required
application/json
  • name
    Type: string

    New name for the GPU VM

  • resourceGroupId
    Type: stringFormat: uuid

    Resource group ID to assign the VM to

  • sshKeyId
    Type: stringFormat: uuid nullable

    SSH key ID to associate with the VM, or null to clear the association

  • username
    Type: string
    min length:  
    3
    max length:  
    20     Pattern: ^[a-zA-Z_][a-zA-Z0-9_-]*$

    Username for SSH access (must start with a letter or underscore)

Responses
  • application/json
  • application/json
  • application/json
  • 403

    GPU feature not enabled for this entity

  • application/json
  • application/json
Request Example for put/resource/gpu/{id}
curl https://api.gpcn.com/v1/resource/gpu/123e4567-e89b-12d3-a456-426614174000 \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_SECRET_TOKEN' \
  --data '{
  "name": "",
  "resourceGroupId": "",
  "sshKeyId": "",
  "username": ""
}'

{
  "success": true,
  "message": "string",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "string",
    "createdAt": "2026-05-19T14:02:02.487Z",
    "updatedAt": "2026-05-19T14:02:02.487Z",
    "deletedAt": "2026-05-19T14:02:02.487Z",
    "status": "Provisioning",
    "configuration": {
      "name": "string",
      "code": "string",
      "gpuCount": 1,
      "cpu": 1,
      "ram": 1,
      "disk": 1,
      "skuId": "123e4567-e89b-12d3-a456-426614174000",
      "skuCode": "string"
    },
    "ip": "string",
    "datacenter": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "string",
      "region": "string",
      "countryAbbr": "string",
      "country": "string"
    },
    "resourceGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "resourceGroupName": "string",
    "image": "string",
    "jupyterUrl": "string",
    "username": "string",
    "sshKeyId": "123e4567-e89b-12d3-a456-426614174000",
    "sshKeyName": "string",
    "hasStoredCredentials": true
  },
  "meta": null
}

GPU VM updated successfully