Pass arguments with YAML

Tip

Learn more about: - Pass arguments action features - Pass arguments integrations - Pass arguments alternatives

YAML parameters for Pass arguments

Hint

List with common parameters for all Buddy actions

Name	Type	Description
action `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `WAIT_FOR_VARIABLES`.
variables `Required`	Variable[]	The list of variables to set as parameters for the pipeline. At least one parameter is required.
key `Required`	String	The name of the parameter.
defaults	String	The value of the parameter.
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.

YAML example for Pass parameters

yaml
actions:
- action: "Pass arguments"
  type: "WAIT_FOR_VARIABLES"
  trigger_time: "ON_EVERY_EXECUTION"
  comment: "Version should be like X.Y.Z"
  variables:
  - key: "key1"
    encrypted: true
    defaults: "param1"
  - key: "key2"
    defaults: "param2"
  - key: "key3"
    init_path: "file"
  - key: "param1"    
    defaults: "option1\noption2\noption3"

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.

yaml
  permissions:
    others: "DENIED"
    users:
      alex@buddy.works: "DENIED"
      mike@buddy.works: "ALLOWED"
    groups:
      frontend: "DENIED"
      backend: "ALLOWED"

Last modified on Mar 4, 2025

Operate sandbox Ping monitoring