Get Sandbox as YAML

View as Markdown

GET
/workspaces
/:workspace
/sandboxes
/:sandbox_id
/yaml

Get sandbox configuration as YAML

Request

REQUIRED SCOPES

SANDBOX_INFO

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

sandbox_idrequiredstring

The ID of the sandbox

Example: "sb-1234567890abcdef"

Response

RESPONSE BODY

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

yamlstring

The base64-encoded YAML configuration of the sandbox

Last modified on Jan 26, 2026

Get Sandbox App Logs Get Sandbox Content

Request example

CURL
curl -X GET "https://api.buddy.works/workspaces/:workspace/sandboxes/:sandbox_id/yaml" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json"

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/sandboxes/sb-12345",
  "html_url": "https://app.buddy.works/my-project/sandboxes/sb-12345",
  "yaml": "LSBzYW5kYm94OiBteS1hcGktc2FuZGJveAogIG5hbWU6IE15IEFQSSBEZXZlbG9wbWVudCBTYW5kYm94CiAgb3M6IHVidW50dToyNC4wNAogIHJlc291cmNlczogMng0CiAgaW5zdGFsbF9jb21tYW5kczogbnBtIGluc3RhbGwgJiYgbnBtIHJ1biBidWlsZAogIGFwcHM6CiAgLSBucG0gc3RhcnQKICBhcHBfZGlyOiAvYXBwCiAgZW5kcG9pbnRzOgogIC0gbmFtZTogd3d3CiAgICBlbmRwb2ludDogODAKICAgIHR5cGU6IEhUVFAKICAgIHJlZ2lvbjogRVUKICAgIHRpbWVvdXQ6IDMwCiAgICBodHRwOgogICAgICB2ZXJpZnlfY2VydGlmaWNhdGU6IHRydWUKICAgICAgY29tcHJlc3Npb246IHRydWUKICAgICAgaHR0cDI6IHRydWUKICAgICAgbG9nX3JlcXVlc3RzOiB0cnVlCiAgICAgIGNpcmN1aXRfYnJlYWtlcjogNQogICAgICBzZXJ2ZV9wYXRoOiAvYXBpCg=="
}

STATUS
200 OK