Request a managed Sandbox backup

POST/api/box/v1/{boxId}/backups

Sandbox only; Lite returns backupUnsupported. Admission requires active boxRun access and no nonterminal command; competing commands/snapshots can return backupBusy. Snapshot advancement also requires fileRead permission to observe an already funded running lease; it never starts a VM. At most 256 MiB and 20,000 entries. The UUID requestId is retained even after expiry/deletion and never resnapshots under the same identity. Authority/input changes conflict. HTTP 202 acknowledges durable workflow admission, not completed backup; poll the returned backup.id. Retention follows the organization plan, exposed as expiresAt. Snapshot and transfer may become failed or unknown and must not be assumed complete. A complete backup may report snapshotCleanupPending while temporary runtime cleanup finishes; its retained data is complete.

组织 API Key 鉴权

Authorization: Bearer $SINECLOUD_API_KEY

所需权限: boxRun, fileRead

参数

boxId · path · 必填

Existing Box resource ID selected in Console, not its parent product activation ID.

请求体

必填

application/json

响应

202

Durable backup state after workflow advancement.

400

Invalid fields, identity, path, cursor or query. Unknown/duplicate fields are rejected where validated.

401

Missing, invalid, expired or revoked organization credential.

403

Current issuer membership, product scope, project, resource lifecycle or entitlement denies access.

404

Resource, execution, snapshot, restore or file not found within the authorized organization.

409

State/identity conflict or unresolved execution. Observe the original durable identity; do not create replacement work to bypass uncertainty.

413

JSON body exceeds its byte limit.

415

Use Content-Type: application/json.

500

The request could not be completed. Preserve any durable identity before retrying.

503

Runtime, deployment or recovery evidence is unavailable. Read existing status before retrying an uncertain mutation.