List Sandboxes

GET
/workspaces
/:workspace
/sandboxes

Returns a list of all sandboxes in a project. The project_name parameter is required.

Request

REQUIRED SCOPES

WORKSPACE, SANDBOX_INFO

URL PARAMETERS

workspacerequired string

The workspace name.

Last modified on Sep 2, 2025

Get Sandbox YAML Get Sandbox App Logs

Example:

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

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/sandboxes",
  "html_url": "https://app.buddy.works/buddy/sandboxes/sandboxes",
  "sandboxes": [
    {
      "url": "https://api.buddy.works/workspaces/buddy/sandboxes/j7vavf8gd3oce",
      "html_url": "https://app.buddy.works/buddy/sandboxes/sandboxes/j7vavf8gd3oce",
      "id": "j7vavf8gd3oce",
      "identifier": "failed_command",
      "name": "Failed command",
      "status": "RUNNING"
    },
    {
      "url": "https://api.buddy.works/workspaces/buddy/sandboxes/nyqjlhci8gn0h",
      "html_url": "https://app.buddy.works/buddy/sandboxes/sandboxes/nyqjlhci8gn0h",
      "id": "nyqjlhci8gn0h",
      "identifier": "stopped",
      "name": "Stopped",
      "status": "STOPPED"
    },
    {
      "url": "https://api.buddy.works/workspaces/buddy/sandboxes/pzgjilkoje33a",
      "html_url": "https://app.buddy.works/buddy/sandboxes/sandboxes/pzgjilkoje33a",
      "id": "pzgjilkoje33a",
      "identifier": "service_nginx",
      "name": "Service Nginx",
      "status": "RUNNING"
    },
    {
      "url": "https://api.buddy.works/workspaces/buddy/sandboxes/tx3em8iedxq5m",
      "html_url": "https://app.buddy.works/buddy/sandboxes/sandboxes/tx3em8iedxq5m",
      "id": "tx3em8iedxq5m",
      "identifier": "running",
      "name": "Running",
      "status": "RUNNING"
    },
    {
      "url": "https://api.buddy.works/workspaces/buddy/sandboxes/w65x2i39zcq5i",
      "html_url": "https://app.buddy.works/buddy/sandboxes/sandboxes/w65x2i39zcq5i",
      "id": "w65x2i39zcq5i",
      "identifier": "command_nginx",
      "name": "Command Nginx",
      "status": "RUNNING"
    }
  ]
}

STATUS
200 OK

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