Kubernetes Run Pod

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /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_RUN_POD.
auth_typerequired string
Authorization type. Can be one of BASIC, TOKEN or CERTS.
serverrequired string
The host for the connection.
save_config_argoptional boolean
If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
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.
record_argoptional string
Record current kubectl command in the resource annotation. Can be one of TRUE, FALSE or NOT_SET. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
leave_afteroptional boolean
Defines whether to leave the Pod or delete it after the action finishes.
config_pathoptional string
The repository path to the configuration file. One of config_path or content must be specified.
contentoptional string
The configuration content. One of config_path or content must be specified.
kubectl_versionoptional string
Version of the kubectl used in the action. Default is “latest”.

Last modified on Oct 7, 2024

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 Pod",
  "type": "KUBERNETES_RUN_POD",
  "trigger_time": "ON_EVERY_EXECUTION",
  "auth_type": "BASIC",
  "server": "https://123.45.56.89:6443",
  "login": "admin",
  "password": "qwerty",
  "record_arg": "NOT_SET",
  "config_path": "config.yaml",
  "leave_after": true,
  "kubectl_version": "1.11.1"
}'
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 Pod", "type": "KUBERNETES_RUN_POD", "trigger_time": "ON_EVERY_EXECUTION", "auth_type": "BASIC", "server": "https://123.45.56.89:6443", "login": "admin", "password": "qwerty", "record_arg": "NOT_SET", "config_path": "config.yaml", "leave_after": true, "kubectl_version": "1.11.1", "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