Skip to navigation

List Cloud VM snapshots in the workspace

Lists snapshot sets of every Cloud VM in the workspace, as the portal’s Snapshots page does. 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/cloud-vm-snapshots?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.

limitintegerOptional1-500Defaults to 100

Maximum number of snapshot sets to return (1-500). Default 100.

offsetintegerOptional>=0Defaults to 0
Number of items to skip before the first returned item. Default 0.
searchstringOptional>=1 character
Return only snapshot sets whose fields contain this text.

Response

Snapshot sets returned successfully.
snapshotslist of objects
Snapshot sets on this page.
totalintegerDefaults to 0
Total number of snapshot sets 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