Pass arguments

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

Hint

List with common parameters for all Buddy 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

namerequired string

The name of the action.

typerequired string

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

commentoptional string

The custom comment that will be visible upon passing the arguments.

permissionsoptional PipelinePermissions

Define to set permissions for the action.

Last modified on Oct 7, 2024

Snapshot Ping monitoring

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": "Pass parameters",
  "type": "WAIT_FOR_VARIABLES",
  "trigger_time": "ON_EVERY_EXECUTION",
  "comment": "Version should be like X.Y.Z",
  "variables": [
    {
      "key": "version"
    },
    {
      "key": "pass",
      "encrypted": true
    }
  ]
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/845",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/845/edit",
  "id": 2,
  "name": "Pass parameters",
  "type": "WAIT_FOR_VARIABLES",
  "trigger_time": "ON_EVERY_EXECUTION",
  "comment": "Version should be like X.Y.Z",
  "variables": [
    {
      "key": "version",
      "value": "1.0"
    },
    {
      "key": "pass",
      "value": "secret_pass",
      "encrypted": true
    }
  ],
  "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