Skip to navigation

Delete a Cloud VM backup run

Deletes one backup run and its recovery point, as the portal’s Backups page does. Requires scope: vm.write.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# RUN_ID: Backup run or recovery-point ID
curl -X DELETE "https://api.ibee.ai/v1/compute/cloud-vm-backups/runs/$RUN_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

run_idstringRequired>=1 character

Backup run or recovery-point 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

Deletion accepted. GET returns status deleting until cleanup completes, then 404.
statusenum
Allowed values:
run_idstring
recovery_point_idstring or nullOptional

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