GKE Run Helm

View as Markdown

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

Info

List with common parameters for all Buddy actions

Request

URL PARAMETERS

workspacerequiredstring

The workspace name.

pipeline_idrequiredinteger

The numerical ID of the desired pipeline.

project_namerequiredstring

The name ID of the project.

POST PARAMETERS

namerequiredstring

The name of the action.

typerequiredstring

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

execute_commandsrequiredstring[]

The commands that will be executed.

integrationrequiredIntegration

The integration.

zone_idrequiredstring

The ID of the GKE zone.

clusterrequiredstring

The ID of the GKE cluster.

application_idrequiredstring

The ID of the GKE application.

helm_versionrequiredstring

The Helm version.

helm_repository_regionstring

Helm repository region. Set it if Helm repository is on AWS S3.

helm_repository_integrationIntegration

Amazon integration ID. Set it if Helm repository is on AWS S3.

helm_repository_keystring

Service Account Key from Google Cloud Storage. Set it if Helm repository is on GCS.

setup_commandsstring[]

Allow you to install Helm plugins.

kubectl_versionstring

Version of the kubectl used in the action. Default is latest.

shellstring

The name of the shell that will be used to execute commands. Can be one of SH (default) or BASH.

Last modified on Jan 19, 2026

GKE kubectl GKE Run Job

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": "Kubernetes - execute: # helm upgrade i myvalues.yaml f override.yaml myApp .chart",
  "type": "HELM",
  "shell": "SH",
  "trigger_time": "ON_EVERY_EXECUTION",
  "cluster": "cluster-1",
  "application_id": "app-id",
  "integration": {
    "identifier": "5ddb7c180fb38be67bd78a88a"
  },
  "zone_id": "europe-west3-a",
  "gke_auth_type": "SERVICE_ACCOUNT",
  "helm_repository_integration": {
    "identifier": "5e1873c2e36b2f65b2896101",
    "type": "AMAZON"
  },
  "execute_commands": [
    "kubectl apply f ./mymanifest.yaml",
    "helm upgrade i myvalues.yaml f override.yaml myApp .chart"
  ],
  "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.0.1",
  "kubectl_version": "latest",
  "timeout": 5
}'

Response

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
  "id": 2,
  "name": "Kubernetes - execute: # helm upgrade i myvalues.yaml f override.yaml myApp .chart",
  "type": "HELM",
  "cluster": "cluster-1",
  "application_id": "app-id",
  "integration": {
    "identifier": "5ddb7c180fb38be67bd78a88a"
  },
  "zone_id": "europe-west3-a",
  "gke_auth_type": "SERVICE_ACCOUNT",
  "shell": "SH",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "disabled": false,
  "helm_repository_integration": {
    "url": "https://api.buddy.works/workspaces/buddy/user/integrations/5e1873c2e36b2f65b2896101",
    "html_url": "https://app.dev.io/my-id",
    "identifier": "5e1873c2e36b2f65b2896101",
    "type": "AMAZON"
  },
  "execute_commands": [
    "kubectl apply f ./mymanifest.yaml",
    "helm upgrade i myvalues.yaml f override.yaml myApp .chart"
  ],
  "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"
  ],
  "kubectl_version": "latest",
  "helm_version": "v3.0.1",
  "run_next_parallel": false,
  "timeout": 5,
  "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": "test server",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "INITIAL",
    "last_execution_revision": null,
    "always_from_scratch": false,
    "ignore_fail_on_project_status": false,
    "no_skip_to_most_recent": false,
    "auto_clear_cache": false,
    "do_not_create_commit_status": false
  }
}

STATUS
201 Created