GKE kubectl
POST Parameters
Name | Type | Description |
---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to KUBERNETES_CLI . |
integration Required | Integration | The integration. |
gke_auth_type Required | String | Authorization type. Can be one of BASIC , SERVICE_ACCOUNT or CERTS . |
zone_id Required | String | The ID of the GKE zone. |
cluster Required | String | The ID of the GKE cluster. |
application_id Required | String | The ID of the GKE application. |
server_key | String | The server key required when gke_auth_type is set to SERVICE_ACCOUNT . |
server Required | String | The host for the connection. |
execute_commands Required | String[] | The commands that will be executed. |
shell | String | The name of the shell that will be used to execute commands. Can be one of SH (default) or BASH . |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions
JSON
{"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": "BASIC","execute_commands": ["kubectl --namespace=buddy-tests get pods"],"integration": {"hash_id": "5ddb7c180fb38be67bd78a88a"}}
Sample Response
HTTP
Status: 201 CreatedX-Rate-Limit-Limit: 1X-Rate-Limit-Remaining: 999
JSON
{"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": "BASIC","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","trigger_mode": "MANUAL","ref_name": "master","last_execution_status": "SUCCESSFUL","last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"}}