VPS

Get rescue mode status

get/vps/{vps_id}/rescue

Check whether your server is in rescue mode, the addresses to reach it on and the result of the last rescue operation. Also tells you whether your firewall blocks SSH.

Autorización

Authorization

Authorization*string

Bearer YOUR_API_TOKEN con un token de API. También vale la cabecera X-API-Key: YOUR_API_TOKEN.

Parámetros de ruta

vps_id*integer

Rango1 ≤ value

Respuestas

Successful Response

application/json

available*boolean

Whether rescue mode can be enabled right now (the rescue system is in the catalogue).

state?string | null

Valores"entering""active""exiting""failed"

configured?boolean

Por defectofalse

started_at?string | null

Formatodate-time

ip_addresses?array<string>

ssh_firewall_warning?boolean

Por defectofalse

last_task?VPSRescueTaskOut | null

Last rescue operation of the server.

Propiedades (4)

task_type*string

status*string

result_message?string | null

updated_at?string | null

Formatodate-time

Ejemplo de petición

GET/vps/{vps_id}/rescue

curl -X GET "https://api.cubepath.com/vps/1/rescue" \
  -H "Authorization: Bearer $CUBEPATH_API_TOKEN"

Ejemplo de respuesta

{
  "available": true,
  "state": "entering",
  "configured": false,
  "started_at": "2026-01-01T00:00:00Z",
  "ip_addresses": [
    "203.0.113.10"
  ],
  "ssh_firewall_warning": false,
  "last_task": {
    "task_type": "string",
    "status": "string",
    "result_message": "string",
    "updated_at": "2026-01-01T00:00:00Z"
  }
}