BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsDomainsSandboxesSelf-HostedAgents & TunnelsYAMLBuddy GitFAQAPI

Kubernetes Set Image

  • POST
  • /workspaces
  • /:workspace
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions
Hint
List with common parameters for all Buddy actions

Request

URL PARAMETERS
workspacerequired string
The workspace name.
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_SET_IMAGE.
auth_typerequired string
Authorization type. Can be one of BASIC, TOKEN or CERTS.
serverrequired string
The host for the connection.
containerrequired string
The name of the container.
namespacerequired string
The name of the namespace.
deploymentrequired string
The name of the deployment from the namespace.
image_namerequired string
The name of the image to set.
image_tagrequired string
The tag of the chosen image.
loginstring
The username required when auth_type is set to BASIC.
passwordstring
The password required when auth_type is set to BASIC.
tokenstring
The token required when auth_type is set to TOKEN.
client_castring
The certificate authority required when auth_type is set to CERTS.
client_certstring
The client certificate required when auth_type is set to CERTS.
client_keystring
The client key required when auth_type is set to CERTS.
record_argstring
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.
kubectl_versionstring
Version of the kubectl used in the action. Default is latest.

Last modified on Oct 16, 2025

Previous pageKubernetes Run PodNext pageLighthouse

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": "Set image",
  "type": "KUBERNETES_SET_IMAGE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "auth_type": "BASIC",
  "server": "https://123.45.56.89:6443",
  "login": "admin",
  "password": "qwerty",
  "deployment": "nginx-deployment",
  "namespace": "default",
  "image_name": "nginx",
  "image_tag": "1.7.8",
  "record_arg": "NOT_SET",
  "container": "nginx",
  "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": "Set image",
  "type": "KUBERNETES_SET_IMAGE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "auth_type": "BASIC",
  "server": "https://123.45.56.89:6443",
  "login": "admin",
  "password": "qwerty",
  "deployment": "nginx-deployment",
  "namespace": "default",
  "image_name": "nginx",
  "image_tag": "1.7.8",
  "record_arg": "NOT_SET",
  "container": "nginx",
  "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