SSH to sandbox

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

Request

URL PARAMETERS

domainrequired string

The workspace domain.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

project_namerequired string

The name ID of the project.

POST PARAMETERS

actionrequired string

The ID of the action.

typerequired string

The type of the action. Must be set to SANDBOX_EXEC.

working_directorystring

The absolute or relative path on the sandbox.

userstring

The name of the local (to the sandbox server) user who uploads the files.

commandsrequired string[]

The array of commands invoked on the sandbox.

shellstring

The name of the shell used to execute commands. Can be one of BASH (default) or SH.

sandbox_referencesrequired string[]

Defines the sandbox selection method. Available values: BY_TAGS, BY_NAME, BY_PROJECT, BY_DAYS, BY_ID, BY_ACTION.

sandbox_idstring

ID of the sandbox to which the files are uploaded. Required when sandbox_references is set to BY_ID.

referenced_action_idinteger

ID of the action that creates the target sandbox.Required when sandbox_references is set to BY_ACTION.

referenced_sanbox_namestring

Name of the target sandbox. Required when sandbox_references is set to BY_NAME.

tagsstring[]

List of tags applied to the target sandbox. Required when sandbox_references is set to BY_TAGS.

sandbox_project_idinteger

ID of the project with the target sandbox. Required when sandbox_references is set to BY_PROJECT.

daysinteger

Number of days passed since the creation of the target sandbox. One of 1, 2, 3, 7, 14, 30. Required when sandbox_references is set to BY_DAYS.

execute_every_commandboolean

If set to true all commands will be executed regardless of the result of the previous command.

Last modified on Sep 27, 2024

Proxy SSL verify

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Execute command in sandbox",
  "type": "SANDBOX_EXEC",
  "trigger_time": "ON_EVERY_EXECUTION",
  "user": "ubuntu",
  "working_directory": "/root",
  "shell": "BASH",
  "sandbox_id": "Cgn3QO34klUri",
  "sandbox_references": [
    "BY_ID"
  ],
  "execute_every_command": true,
  "commands": [
    "ls"
  ]
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/2/edit",
  "id": 2,
  "name": "Execute command in sandbox",
  "type": "SANDBOX_EXEC",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "user": "ubuntu",
  "working_directory": "/root",
  "shell": "BASH",
  "sandbox_id": "Cgn3QO34klUri",
  "sandbox_references": [
    "BY_ID"
  ],
  "execute_every_command": true,
  "commands": [
    "ls"
  ],
  "pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
    "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
    "id": 2,
    "name": "Live mirror",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}

STATUS
201 Created

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