Get VM Rescue State

​

Returns the current rescue state of a virtual machine, including the source image if the VM is in rescue mode.

Path Parameters
  • id
    Type: stringFormat: uuid
    required

    Virtual machine ID

Responses
  • application/json
  • 400

    Bad request

  • 404

    Virtual machine not found

  • 500

    Internal server error

Request Example for get/resource/virtual-machines/{id}/rescue
curl https://api.gpcn.com/v1/resource/virtual-machines/123e4567-e89b-12d3-a456-426614174000/rescue \
  --header 'X-API-Key: YOUR_SECRET_TOKEN'

{
  "success": true,
  "data": {
    "rescued": false,
    "image": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "string",
      "osFamily": "string"
    }
  }
}

Rescue state retrieved successfully