Kubernetes kubectl

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

Hint

List with common parameters for all Buddy 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 KUBERNETES_CLI.

auth_typerequired string

Authorization type. Can be one of BASIC, TOKEN or CERTS.

serverrequired string

The host for the connection.

execute_commandsrequired string[]

The commands that will be executed.

loginoptional string

The username required when auth_type is set to BASIC.

passwordoptional string

The password required when auth_type is set to BASIC.

tokenoptional string

The token required when auth_type is set to TOKEN.

client_caoptional string

The certificate authority required when auth_type is set to CERTS.

client_certoptional string

The client certificate required when auth_type is set to CERTS.

client_keyoptional string

The client key required when auth_type is set to CERTS.

kubectl_versionoptional string

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

shelloptional string

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

Last modified on Oct 7, 2024

Kubernetes Apply Deployment Configuration Kubernetes Run Helm CMDs

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": "Run kubectl",
  "type": "KUBERNETES_CLI",
  "trigger_time": "ON_EVERY_EXECUTION",
  "auth_type": "BASIC",
  "server": "https://123.45.56.89:6443",
  "login": "admin",
  "password": "qwerty",
  "shell": "SH",
  "kubectl_version": "1.11.1",
  "execute_commands": [
    "kubectl --namespace=buddy-tests get pods"
  ]
}'

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": "Run kubectl",
  "type": "KUBERNETES_CLI",
  "trigger_time": "ON_EVERY_EXECUTION",
  "auth_type": "BASIC",
  "server": "https://123.45.56.89:6443",
  "login": "admin",
  "password": "qwerty",
  "shell": "SH",
  "kubectl_version": "1.11.1",
  "execute_commands": [
    "kubectl --namespace=buddy-tests get pods"
  ],
  "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 pipeline",
    "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