GKE 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.
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.
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.
not_waitoptional boolean
Defines whether the execution should or should not wait for job to end.

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",
  "zone_id": "europe-west1-c",
  "cluster": "cluster-1",
  "application_id": "tokyo-house-138923",
  "gke_auth_type": "SERVICE_ACCOUNT",
  "record_arg": "NOT_SET",
  "leave_after": true,
  "not_wait": true,
  "config_path": "config.yaml",
  "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 Pod", "type": "KUBERNETES_RUN_POD", "trigger_time": "ON_EVERY_EXECUTION", "zone_id": "europe-west1-c", "cluster": "cluster-1", "application_id": "tokyo-house-138923", "gke_auth_type": "SERVICE_ACCOUNT", "record_arg": "NOT_SET", "leave_after": true, "not_wait": true, "config_path": "config.yaml", "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