Skip to navigation

List cloud VM recovery points

Lists the finished, successful backup runs (usable recovery points) of one cloud VM, newest first. A run being deleted shows status: deleting. Queued, running, failed and cancelled runs are not listed: read a run by ID with GET /compute/cloud-vm-backups/runs/{run_id} to see those states. The backup policy’s last_status shows how the latest finished run ended. Requires scope: vm.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# VM_ID: Virtual machine ID
curl "https://api.ibee.ai/v1/compute/cloud-vms/$VM_ID/backups/runs?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

vm_idstringRequired
Virtual machine ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

limitintegerOptional1-200Defaults to 50
Maximum number of records to return.
offsetintegerOptional>=0Defaults to 0
Number of items to skip before the first returned item. Default 0.
searchstringOptional>=1 character
Return only backup runs whose fields contain this text.

Response

Backup runs returned successfully.
runslist of objects
Backup runs on this page.
totalintegerDefaults to 0
Total number of runs matching the request.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error