Install Self-Hosted
Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesSelf-HostedAgents & TunnelsYAML

Kubernetes Run Helm CMDs

View as Markdown
  • POST
  • /workspaces
  • /:workspace
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions

Creates a new Kubernetes Run Helm CMDs action in the pipeline

Request

REQUIRED SCOPES
EXECUTION_MANAGE
URL PARAMETERS
workspacerequiredstring
The human-readable ID of the workspace

Example: "my-company"

project_namerequiredstring
The human-readable ID of the project

Example: "my-project"

pipeline_idrequiredinteger
The ID of the pipeline

Example: 123

POST PARAMETERS
typerequiredstring enum
The type of the action
Allowed enum:
HELM
urlread-onlystring
API endpoint to GET this object
html_urlread-onlystring
Web URL to view this object in Buddy.works
after_action_idinteger
The numerical ID of the action, after which this action should be added
namerequiredstring
The name of the action
trigger_timestring enum
Specifies when the action should be executed
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
trigger_conditionsTriggerConditionView[]
The list of trigger conditions to meet so that the action can be triggered
run_nextstring enum
Defines whether the action should run in parallel with the next one
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE
variablesEnvironmentVariableView[]
The list of variables you can use the action
disabledboolean
When set to true the action is disabled. By default it is set to false
timeoutinteger
The timeout in seconds
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions
retry_countinteger
Number of retries if the action fails
retry_intervalinteger
Delay time between auto retries in seconds
loopstring[]
The list of commands that will be executed in a loop
current_revisionstring
The git revision of the last successful run of the action
permissionsPermissionsView
Access permissions configuration
config_pathstring
The path to the Kubernetes configuration file
kubectl_versionstring
The version of kubectl to use
setup_commandsstring[]
The command that will be executed only on the first run
targetsTargetView[]
The list of Kubernetes cluster targets
namespacerequiredstring
The Kubernetes namespace
contentstring
The content of the Kubernetes configuration
execute_every_commandboolean
If set to true all commands will be executed regardless of the result of the previous command
shellstring enum
The name of the shell that will be used to execute commands
Allowed enum:
SH,
BASH,
POWERSHELL
execute_commandsstring[]
Commands that will be executed
helm_versionstring
The Helm version
helm_repository_keystring
Service Account Key from Google Cloud Storage. Set it if Helm repository is on GCS
helm_repository_regionstring
Helm repository region. Set it if Helm repository is on AWS S3
helm_repository_integrationIntegrationRequestView
Helm repository integration (GOOGLE_SERVICE_ACCOUNT|AMAZON)

Response

RESPONSE BODY
typestring enum
The type of the action
Allowed enum:
HELM
urlread-onlystring
API endpoint to GET this object
html_urlread-onlystring
Web URL to view this object in Buddy.works
idinteger
The ID of the action
namestring
The name of the action
current_revisionstring
The git revision of the last successful run of the action
trigger_timestring enum
Specifies when the action should be executed
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
trigger_conditionsTriggerConditionView[]
The list of trigger conditions to meet so that the action can be triggered
run_nextstring enum
Defines whether the action should run in parallel with the next one
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE
variablesEnvironmentVariableView[]
The list of variables you can use the action
disabledboolean
When set to true the action is disabled. By default it is set to false
timeoutinteger
The timeout in seconds
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions
retry_countinteger
Number of retries if the action fails
retry_intervalinteger
Delay time between auto retries in seconds
last_execution_statusstring enum
The status of the last run of the action
Allowed enum:
INPROGRESS,
ENQUEUED,
TERMINATED,
SUCCESSFUL,
FAILED,
INITIAL,
NOT_EXECUTED,
SKIPPED,
TERMINATING,
WAITING_FOR_APPLY,
WAITING_FOR_VARIABLES,
WAITING_FOR_SETTABLE_VARIABLES,
WAITING_FOR_VT_SESSION
pipelineShortPipelineView
Short representation of a pipeline
permissionsPermissionsView
Access permissions configuration
loopstring[]
The list of commands that will be executed in a loop
config_pathstring
The path to the Kubernetes configuration file
kubectl_versionstring
The version of kubectl to use
setup_commandsstring[]
The command that will be executed only on the first run
targetsTargetView[]
The list of Kubernetes cluster targets
namespacestring
The Kubernetes namespace
contentstring
The content of the Kubernetes configuration
execute_every_commandboolean
If set to true all commands will be executed regardless of the result of the previous command
shellstring enum
The name of the shell that will be used to execute commands
Allowed enum:
SH,
BASH,
POWERSHELL
execute_commandsstring[]
Commands that will be executed
helm_versionstring
The Helm version
helm_repository_keystring
Service Account Key from Google Cloud Storage. Set it if Helm repository is on GCS
helm_repository_regionstring
Helm repository region. Set it if Helm repository is on AWS S3
helm_repository_integrationIntegrationIdentifierView
The integration used by the action

Last modified on Mar 18, 2026

Previous pageEdit actionNext pageGet action

Request example

curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "K8s Helm",
  "disabled": true,
  "type": "HELM",
  "trigger_time": "ON_EVERY_EXECUTION",
  "trigger_conditions": [
    {
      "trigger_condition": "ON_CHANGE"
    },
    {
      "trigger_condition": "HOUR",
      "trigger_hours": [
        8,
        9,
        10
      ],
      "timezone": "Europe/Warsaw"
    }
  ],
  "targets": [
    {
      "role_arn": "arn:aws:iam::123456789012:role/eks-cluster-service-role",
      "region": "eu-central-1",
      "identifier": "my_target_id",
      "name": "my-target",
      "integration": "hiqfilrcfx",
      "type": "EKS",
      "scope": "ACTION",
      "tags": [
        "olive",
        "orange",
        "rabsperry"
      ],
      "cluster": "https://192.168.5.226:6443"
    }
  ],
  "helm_repository_integration": {
    "identifier": "aws"
  },
  "helm_repository_region": "us-west-2",
  "execute_commands": [
    "kubectl get namespaces -o=custom-columns=NAME:.metadata.name",
    "cat ~/.kube/config"
  ],
  "setup_commands": [
    "helm plugin install https://github.com/hypnoglow/helm-s3.git --version 0.7.0",
    "helm plugin install https://github.com/hayorov/helm-gcs --version 0.2.1"
  ],
  "helm_version": "v3.10.2",
  "variables": [
    {
      "key": "env_key",
      "value": "env_value",
      "type": "VAR",
      "settable": false,
      "run_only_settable": false,
      "encrypted": false,
      "description": "twcksymvsi"
    }
  ],
  "shell": "BASH",
  "kubectl_version": "latest",
  "timeout": 1800,
  "retry_interval": 60,
  "retry_count": 5,
  "ignore_errors": true,
  "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150",
  "loop": [
    "env_key"
  ]
}'
STATUS
200 OK