Skip to navigation

List Gpu VM backup runs in the workspace

Lists the finished, successful backup runs (usable recovery points) of every Gpu VM in the workspace, newest first, as the portal’s Backups page does. A run being deleted shows status: deleting. Queued, running, failed and cancelled runs are not listed: read a run by ID with GET /compute/gpu-vm-backups/runs/{run_id} to see those states. Filter by vm_id or status. Requires scope: vm.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
curl "https://api.ibee.ai/v1/compute/gpu-vm-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.

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.

vm_idstringOptional>=1 character
Return only runs of this VM.
statuslist of enumsOptional

Return only runs in these states. Repeat the parameter for several states. Only succeeded and deleting can match; any other state returns an empty list.

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
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