Manage sandbox

POST
/workspaces
/:workspace
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Info

List with common parameters for all Buddy actions

Manages existing sandboxes in your pipeline. The action can perform various operations such as starting, stopping, deleting, managing applications, and creating snapshots. Use targets to specify which sandboxes to operate on and operation to define what action to perform.

Request

URL PARAMETERS

workspacerequiredstring

The workspace name.

project_namerequiredstring

The name ID of the project.

pipeline_idrequiredinteger

The numerical ID of the desired pipeline.

POST PARAMETERS

namerequiredstring

The name of the action.

typerequiredstring

The type of the action. Should be set to SANDBOX_MANAGE.

operationrequiredstring

The operation to perform on the sandbox. Available values: START, STOP, DELETE, APP_START, APP_RESTART APP_STOP, CREATE_SNAPSHOT.

targetsrequiredtarget[]

Array of sandbox targets to perform the operation on. Can be specific sandbox names or filters.

snapshot_namestring

The name for the snapshot when operation is CREATE_SNAPSHOT. Can use Buddy variables like $BUDDY_RUN_ID.

Last modified on Jan 19, 2026

MacOS Microsoft Teams

Request example


curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Start sandbox app",
  "type": "SANDBOX_MANAGE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "SUCCESSFUL",
  "disabled": false,
  "operation": "APP_START",
  "targets": [
    {
      "identifier": "create-sb",
      "scope": "ANY",
      "type": "MATCH"
    }
  ],
  "ignore_errors": false,
  "run_next_parallel": false
}'

Response

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/my-project/pipelines/541034/actions/1674062",
  "html_url": "https://app.buddy.works/buddy/my-project/pipelines/pipeline/541034/action/1674062/edit",
  "id": 1674062,
  "name": "Start sandbox app3",
  "type": "SANDBOX_MANAGE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "disabled": false,
  "targets": [
    {
      "identifier": "create-sb",
      "scope": "ANY",
      "type": "MATCH"
    }
  ],
  "pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/my-project/pipelines/541034",
    "html_url": "https://app.buddy.works/buddy/my-project/pipelines/pipeline/541034",
    "id": 541034,
    "identifier": "sandbox-api",
    "name": "Sandbox API",
    "definition_source": "LOCAL",
    "git_config_ref": "NONE",
    "refs": [
      "refs/heads/main"
    ],
    "priority": "NORMAL",
    "disabled": false,
    "last_execution_status": "INITIAL",
    "always_from_scratch": false,
    "ignore_fail_on_project_status": false,
    "strict_context": false,
    "no_skip_to_most_recent": false,
    "terminate_stale_runs": false,
    "auto_clear_cache": false,
    "fetch_all_refs": false,
    "fail_on_prepare_env_warning": true,
    "concurrent_pipeline_runs": false,
    "do_not_create_commit_status": false,
    "stale": false,
    "waiting_for_push": false,
    "resources": "DEFAULT",
    "git_changeset_base": "LATEST_RUN",
    "filesystem_changeset_base": "DATE_MODIFIED",
    "cpu": "X64",
    "description_required": false
  },
  "ignore_errors": false,
  "run_next": "WAIT_ON_SUCCESS",
  "operation": "APP_START"
}

STATUS
201 Created