Delete custom image

​

Deletes the image from all datacenters it's deployed to and removes the image record. To remove the image from a single datacenter (leaving it deployed elsewhere), use DELETE /custom-images/{id}/deployments/{datacenterId} instead.

Returns an async job when there are deployments to clean up; otherwise completes immediately. Only the image owner can delete; non-owners receive 403.

Path Parameters

  • id
    Type: stringFormat: uuid
    required

    Custom image ID

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 \
  --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-10-21T16:19:07.197Z",
    "timeRemaining": "string",
    "canRetry": true,
    "isCompleted": true,
    "isTerminal": true,
    "hasFailed": true,
    "resourceId": "123e4567-e89b-12d3-a456-426614174000",
    "resourceName": "string",
    "createdAt": "2026-10-21T16:19:07.197Z",
    "updatedAt": "2026-10-21T16:19:07.197Z"
  },
  "meta": null
}

Deletion accepted. If cleanup is needed, returns a job for tracking. Otherwise data is null.

Previous
Update custom image
Next
Bulk Delete Custom Images