Get Sandbox YAML

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

Retrieve YAML configuration for a specific sandbox. This endpoint returns the sandbox configuration in YAML format encoded in base64.

Request

REQUIRED SCOPES

WORKSPACE, SANDBOX_INFO

URL PARAMETERS

workspacerequired string

The workspace name.

sandbox_idrequired string

The ID of the sandbox.

Last modified on Sep 2, 2025

Get Sandbox List Sandboxes

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.awsdev.net/workspaces/buddy/projects/my-project/sandboxes/jp517h9nuas7j",
  "html_url": "https://app.awsdev.net/buddy/my-project/sandboxes/jp517h9nuas7j",
  "yaml": "LSBzYW5kYm94OiBzZXJ2aWNlX25naW54CiAgbmFtZTogU2VydmljZSBOZ2lueAogIG9zOiB1YnVudHU6MjQuMDQKICByZXNvdXJjZXM6IDF4MgogIGluc3RhbGxfY29tbWFuZHM6IHwtCiAgICBhcHQtZ2V0IHVwZGF0ZQogICAgYXB0LWdldCBpbnN0YWxsIC15IG5naW54CiAgdGFnczoKICAtIG9yYW5nZQogIC0gcmFic3BlcnJ5CiAgLSBvbGl2ZQogIC0gcHVycGxlCiAgcnVuX2NvbW1hbmQ6IG5naW54CiAgYXBwX3R5cGU6IFNFUlZJQ0UKICBlbmRwb2ludHM6CiAgLSBuYW1lOiB5cnRraW1rdnBqCiAgICBlbmRwb2ludDogODAKICAgIHJlZ2lvbjogRVUK"
}

STATUS
200 OK

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999