Sign in
Sandbox API

Create a new snapshot of a sandbox

post/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/snapshots

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

sandbox_idstring required
Example:sb-1234567890abcdef

The ID of the sandbox

Request body

namestring

Snapshot name

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

idstring

The ID of the snapshot

namestring

Snapshot name

sizeinteger

Snapshot size in GB

status'CREATING' | 'CREATED' | 'DELETING' | 'FAILED'

Snapshot status

create_datestring date-time

Snapshot creation date

Changes

Changed in 1 of the 8 revisions of this API.2

  • fa785a68f09d2See the full diff
    • ○

      the security scope SANDBOX_WRITE was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope SANDBOX_MANAGE was removed from the endpoint's security scheme oauth2

      api-security-scope-removed