v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Sandbox API

Get a specific snapshot by ID

get/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/snapshots/{id}

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

idstring required
Example:snap-abcdef1234567890

The ID of the snapshot

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