List a custom image's deployments

​

Returns every active deployment of this image, one row per (image, datacenter), including the current state and any failureReason. Same data is also embedded inside GET /resource/custom-images/{id} — this endpoint is provided for callers that only need the deployment list.

Path Parameters

  • id
    Type: stringFormat: uuid
    required

    Custom image ID.

Responses

  • application/json
  • application/json
  • 404

    Image not found or not accessible in your tenant.

  • application/json
Request Example for get/resource/custom-images/{id}/deployments
curl https://api.gpcn.com/v1/resource/custom-images/123e4567-e89b-12d3-a456-426614174000/deployments \
  --header 'X-API-Key: YOUR_SECRET_TOKEN'

{
  "success": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "datacenterId": "123e4567-e89b-12d3-a456-426614174000",
      "datacenterName": "string",
      "datacenterCode": "string",
      "regionName": "string",
      "countryName": "string",
      "continentName": "string",
      "createdAt": "2026-10-21T16:19:07.188Z",
      "state": "registering",
      "stateChangedAt": "2026-10-21T16:19:07.188Z",
      "failureReason": "string"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "pageSize": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}

Deployment list (may be empty). Bounded by the number of datacenters the image is deployed to (~30-50 max), so the response returns all deployments in a single page — meta.totalPages is always 1 and ?page / ?limit are not honoured. The paginated shape is used for consistency with the project's list-endpoint standard.

Previous
Finalize a multipart upload
Next
Deploy a staged custom image to one or more datacenters