Enter Rescue Mode

​

Places a virtual machine into rescue mode by booting from an ISO image. For CloudStack: stops the VM, attaches the ISO, then starts it. For OpenStack: issues a nova rescue action with the ISO as the rescue image reference. This is an async operation — use the returned jobId to track progress.

Path Parameters
  • id
    Type: stringFormat: uuid
    required

    Virtual machine ID

Body
required
application/json
  • sourceImageId
    Type: stringFormat: uuid
    required

    ID of the catalog or custom ISO image

  • sourceType
    Type: stringenum
    required

    Whether the ISO comes from the platform catalog or entity custom images

    values
    • catalog
    • custom
Responses
  • application/json
  • 400

    Bad request — source image not found or rescue not supported on this provider

  • 404

    Virtual machine not found

  • 409

    VM provisioning is not yet complete; rescue is only available once the VM has a provider-side machine id

  • 500

    Internal server error

Request Example for post/resource/virtual-machines/{id}/rescue
curl https://api.gpcn.com/v1/resource/virtual-machines/123e4567-e89b-12d3-a456-426614174000/rescue \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_SECRET_TOKEN' \
  --data '{
  "sourceType": "catalog",
  "sourceImageId": ""
}'

{
  "success": true,
  "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"
  }
}

Rescue operation accepted