Skip to navigation

Delete a cloud VM snapshot

Deletes a cloud VM snapshot set when no restore is running. Requires scope: vm.write.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# SNAPSHOT_SET_ID: VM snapshot-set ID
curl -X DELETE "https://api.ibee.ai/v1/compute/cloud-vm-snapshots/$SNAPSHOT_SET_ID?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

snapshot_set_idstringRequired>=1 character

VM snapshot-set 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.

Response

Snapshot deleted successfully.
statusenum

Always deleted.

Allowed values:
snapshot_set_idstring
ID of the deleted snapshot set.

Errors

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