Set variables

Table of Contents

PipelinePermissions schema UserPermission schema GroupPermission schema

POST Parameters

List with common parameters for all Buddy actions

Name	Type	Description
name `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `SET_VARIABLES`.
variables `Required`	Variable[]	The list of existing settable variables.
key `Required`	String	The name of the variable.
defaults	String	The value of the variable.
encrypted	Boolean	Encrypted values will not be visible once saved. Can be used for things like passwords.
init_path	String	Path to the file with options.
comment	String	The custom comment that will be displayed upon passing arguments.
permissions	PipelinePermissions	Define to set permissions for the action.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions

JSON

{
  "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"
    }
  ]
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "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"
  }
}

PipelinePermissions schema

Name	Type	Description
others	String	AccessLevel for the group Others. Can be one of `DENIED`, `ALLOWED`. Default setting is `ALLOWED`.
users	UserPermission[]	The list of users who will be granted a permission other than the Others group.
groups	GroupPermission[]	The group who will be granted a permission other than the Others group.

UserPermission schema

Name	Type	Description
id `Required`	Integer	The user ID.
access_level `Required`	String	AccessLevel for a user. Can be one of `DENIED`, `ALLOWED`. Default setting is `ALLOWED`.

GroupPermission schema

Name	Type	Description
id `Required`	Integer	The group ID.
access_level `Required`	String	AccessLevel for a group. Can be one of `DENIED`, `ALLOWED`. Default setting is `ALLOWED`.

Last modified on July 5, 2023

Set variables

PipelinePermissions schema

UserPermission schema

GroupPermission schema

Knowledge is power!