GKE kubectl

  • 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_CLI.
integrationrequired Integration
The integration.
gke_auth_typerequired string
Authorization type. Set to SERVICE_ACCOUNT.
zone_idrequired string
The ID of the GKE zone.
clusterrequired string
The ID of the GKE cluster.
application_idrequired string
The ID of the GKE application.
serverrequired string
The host for the connection.
execute_commandsrequired string[]
The commands that will be executed.
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

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",
  "zone_id": "europe-west1-c",
  "cluster": "cluster-1",
  "application_id": "tokyo-house-138923",
  "shell": "SH",
  "gke_auth_type": "SERVICE_ACCOUNT",
  "execute_commands": [
    "kubectl --namespace=buddy-tests get pods"
  ],
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  }
}'
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", "zone_id": "europe-west1-c", "cluster": "cluster-1", "application_id": "tokyo-house-138923", "shell": "SH", "gke_auth_type": "SERVICE_ACCOUNT", "execute_commands": [ "kubectl --namespace=buddy-tests get pods" ], "integration": { "url": "https://api.buddy.works/workspaces/buddy/user/integrations/2", "html_url": "https://app.buddy.works/my-id", "hash_id": "5ddb7c180fb38be67bd78a88a" }, "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