Start

  • 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_START.
sandbox_referencesrequired string[]
Defines the sandbox selection method. Available values: BY_TAGS, BY_NAME, BY_PROJECT, BY_DAYS, BY_ID, BY_ACTION.
sandbox_idoptional string
ID of the sandbox to which the files are uploaded. Required when sandbox_references is set to BY_ID.
referenced_action_idoptional integer
ID of the action that creates the target sandbox.Required when sandbox_references is set to BY_ACTION.
referenced_sanbox_nameoptional string
Name of the target sandbox. Required when sandbox_references is set to BY_NAME.
tagsoptional string[]
List of tags applied to the target sandbox. Required when sandbox_references is set to BY_TAGS.
sandbox_project_idoptional int
ID of the project with the target sandbox. Required when sandbox_references is set to BY_PROJECT.
daysoptional int
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.

Last modified on Sep 23, 2024

{
  "name": "Start sandbox",
  "type": "SANDBOX_START",
  "sandbox_id": "BJ7YnoUVtfGdo",
  "sandbox_references": [
    "BY_ID"
  ],
  "trigger_time": "ON_EVERY_EXECUTION"
}
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/1",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/1/edit",
  "id": 1,
  "name": "Start sandbox",
  "type": "SANDBOX_START",
  "trigger_time": "ON_EVERY_EXECUTION",
  "sandbox_id": "BJ7YnoUVtfGdo",
  "sandbox_references": [
    "BY_ID"
  ],
  "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"
  }
}