Delete custom image

​

Initiate an async deletion workflow for a custom image. If datacenterId is provided, only removes the image from that datacenter. If omitted, removes the image from all datacenters. Requires custom-image:delete permission.

Path Parameters
  • id
    Type: stringFormat: uuid
    required

    Custom image ID

Query Parameters
  • datacenterId
    Type: stringFormat: uuid

    If provided, only removes the image from this specific datacenter

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

{
  "success": true,
  "message": "string",
  "data": {
    "jobId": "123e4567-e89b-12d3-a456-426614174000",
    "resourceType": "virtual_machine",
    "resourceDisplayName": "string",
    "operation": "create",
    "stage": "initializing",
    "progressPercentage": 0,
    "message": "string",
    "errorMessage": "string",
    "estimatedCompletion": "2026-05-19T14:02:02.487Z",
    "timeRemaining": "string",
    "canRetry": true,
    "isCompleted": true,
    "hasFailed": true,
    "resourceId": "123e4567-e89b-12d3-a456-426614174000",
    "resourceName": "string",
    "createdAt": "2026-05-19T14:02:02.487Z",
    "updatedAt": "2026-05-19T14:02:02.487Z"
  },
  "meta": null
}

Deletion accepted. If the image has provider deployments, returns an async job response for tracking. If no deployments exist, the image is soft-deleted synchronously and data is null.