List GPU VMs

Get a paginated list of the GPU VMs you can see in your tenant. Requires the GPU feature to be enabled for your tenant.

You see the GPU VMs in the resource groups you are a member of, which always include your tenant's Default resource group. A caller holding resource-group:bypass for the tenant sees every GPU VM. meta.scope names the groups the list was limited to. resourceGroupId narrows within those groups; naming a group you are not a member of returns no rows, not an error.

Query Parameters

page
Type: integer
min:
1

Page number (1-indexed, default: 1)
limit
Type: integer
min:
1
max:
100

Items per page (max varies by endpoint; default max 100)
sort
Type: string

Sort field and direction (e.g., "createdAt:desc", "name:asc"). Supports comma-separated values for multi-column sorting.
search
Type: string

Search term (searches in GPU VM name)
resourceGroupId
Type: stringFormat: uuid

Filter by resource group ID

Responses

application/json
application/json
403

GPU feature not enabled for your tenant
application/json
application/json

get/resource/gpu

curl 'https://api.gpcn.com/v1/resource/gpu?page=1&sort=createdAt%3Adesc' \
  --header 'X-API-Key: YOUR_SECRET_TOKEN'

Show Schema

{
  "success": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "string",
      "createdAt": "2026-10-21T16:19:07.188Z",
      "updatedAt": "2026-10-21T16:19:07.188Z",
      "deletedAt": "2026-10-21T16:19:07.188Z",
      "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"
    }
  ],
  "meta": {
    "scope": {
      "resourceGroups": [
        {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "name": "Default"
        }
      ],
      "includesUngrouped": false,
      "unrestricted": false
    },
    "total": 1,
    "page": 1,
    "pageSize": 1,
    "totalPages": 1,
    "hasNextPage": true,
    "hasPreviousPage": true
  },
  "error": {
    "code": "GPU_PROVIDER_UNAVAILABLE",
    "message": "string"
  }
}

Successfully retrieved GPU VMs. When real-time provider data is unavailable, the response is still HTTP 200 but carries a top-level error: { code: 'GPU_PROVIDER_UNAVAILABLE', message } alongside the (possibly empty) data array. Check error.code to show a degraded state while continuing to render the cached rows in data.

Get GPU inventory with real-time availability

Create a GPU VM