GKE kubectl

POST Parameters

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to KUBERNETES_CLI.
integration
Required
IntegrationThe integration.
gke_auth_type
Required
StringAuthorization type. Can be one of BASIC, SERVICE_ACCOUNT or CERTS.
zone_id
Required
StringThe ID of the GKE zone.
cluster
Required
StringThe ID of the GKE cluster.
application_id
Required
StringThe ID of the GKE application.
server_keyStringThe server key required when gke_auth_type is set to SERVICE_ACCOUNT.
server
Required
StringThe host for the connection.
execute_commands
Required
String[]The commands that will be executed.

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",
"gke_auth_type": "BASIC",
"execute_commands": [
"kubectl --namespace=buddy-tests get pods"
],
"integration": {
"id": 2
}
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-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",
"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",
"id": 2
},
"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"
}
}