Set variables

  • 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
namerequired string
The name of the action.
typerequired string
The type of the action. Should be set to SET_VARIABLES.
variablesrequired Variable[]
The list of existing settable variables.
keyrequired string
The name of the variable.
defaultsoptional string
The value of the variable.
encryptedoptional boolean
Encrypted values will not be visible once saved. Can be used for things like passwords.
init_pathoptional string
Path to the file with options.
commentoptional string
The custom comment that will be displayed upon passing arguments.
permissionsoptional PipelinePermissions
Define to set permissions for the action.

Last modified on Sep 27, 2024

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": "Set Variables",
  "type": "SET_VARIABLES",
  "trigger_time": "ON_EVERY_EXECUTION",
  "comment": "comment",
  "variables": [
    {
      "key": "var3",
      "init_path": "/fileWithOptions"
    },
    {
      "key": "var2",
      "defaults": "option1\noption2"
    },
    {
      "key": "var1"
    },
    {
      "key": "var4"
    }
  ]
}'
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": "Set Variables", "type": "SET_VARIABLES", "trigger_time": "ON_EVERY_EXECUTION", "comment": "comment", "variables": [ { "key": "var3", "init_path": "/fileWithOptions" }, { "key": "var2", "defaults": "option1\noption2" }, { "key": "var1" }, { "key": "var4" } ], "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