Google Kubernetes Engine

View as Markdown

POST
/workspaces
/:workspace
/targets

Create a new Google Kubernetes Engine deployment target

Request

REQUIRED SCOPES

TARGET_ADD

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

BODY PARAMETERS

typestring

The type of the target

Value: GKE

identifierrequiredstring

A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end).

integrationrequiredstring

The integration. Required when adding GKE/EKS/AKS/DOKS

clusterrequiredstring

The ID of the cluster or fully qualified identifier for the cluster. Required when the platform is set to GKE

zonerequiredstring

GKE zone. E.g., europe-west3-a

project_idrequiredstring

The ID of the Google Cloud project. Required for GOOGLE_SERVICE_ACCOUNT integration type with OIDC auth_type

idstring

The ID of the target

namestring

The name of the target

projectShortProjectView

Short representation of a project

pipelineShortPipelineView

Short representation of a pipeline

environmentShortEnvironmentView

Short representation of an environment object

permissionsPermissionsView

Access permissions configuration

pipelines_access_levelstring enum

Pipelines access level for this target

Allowed enum:

DENIED,

READ_ONLY,

USE_ONLY,

BLIND,

RUN_ONLY,

READ_WRITE,

MANAGE,

DEFAULT,

ALLOWED,

STAGE,

COMMIT

allowed_pipelinesAllowedPipelineView[]

List of specific pipelines allowed to use this target

sandboxes_access_levelstring enum

Sandboxes access level for this target

Allowed enum:

DENIED,

READ_ONLY,

USE_ONLY,

BLIND,

RUN_ONLY,

READ_WRITE,

MANAGE,

DEFAULT,

ALLOWED,

STAGE,

COMMIT

allowed_sandboxesAllowedSandboxView[]

List of specific sandboxes allowed to use this target

disabledboolean

Indicates if this target is disabled (default: false)

tagsstring[]

The list of tags associated with the target

Constraints: Unique items required

use_asUseAsView

Defines how the target can be used (as deployment target, proxy, or both)

regionstring

EKS region, e.g. eu-central-1

proxyTargetK8sProxyView

SSH proxy target for tunneling to private PostgreSQL servers

Response

RESPONSE BODY

typestring

The type of the target

Value: GKE

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

idstring

The ID of the target

identifierrequiredstring

A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end).

namestring

The name of the target

projectShortProjectView

Short representation of a project

pipelineShortPipelineView

Short representation of a pipeline

environmentShortEnvironmentView

Short representation of an environment object

permissionsPermissionsView

Access permissions configuration

pipelines_access_levelstring enum

Pipelines access level for this target

Allowed enum:

DENIED,

READ_ONLY,

USE_ONLY,

BLIND,

RUN_ONLY,

READ_WRITE,

MANAGE,

DEFAULT,

ALLOWED,

STAGE,

COMMIT

allowed_pipelinesAllowedPipelineView[]

List of specific pipelines allowed to use this target

sandboxes_access_levelstring enum

Sandboxes access level for this target

Allowed enum:

DENIED,

READ_ONLY,

USE_ONLY,

BLIND,

RUN_ONLY,

READ_WRITE,

MANAGE,

DEFAULT,

ALLOWED,

STAGE,

COMMIT

allowed_sandboxesAllowedSandboxView[]

List of specific sandboxes allowed to use this target

disabledboolean

Indicates if this target is disabled (default: false)

tagsstring[]

The list of tags associated with the target

Constraints: Unique items required

use_asUseAsView

Defines how the target can be used (as deployment target, proxy, or both)

integrationrequiredstring

The integration. Required when adding GKE/EKS/AKS/DOKS

clusterrequiredstring

The ID of the cluster or fully qualified identifier for the cluster. Required when the platform is set to GKE

regionstring

EKS region, e.g. eu-central-1

proxyTargetK8sProxyView

SSH proxy target for tunneling to private PostgreSQL servers

zonerequiredstring

GKE zone. E.g., europe-west3-a

project_idrequiredstring

The ID of the Google Cloud project. Required for GOOGLE_SERVICE_ACCOUNT integration type with OIDC auth_type

Last modified on Apr 27, 2026

Get target Edit target

Request example


curl -X POST "https://api.buddy.works/workspaces/:workspace/targets" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "GKE",
  "identifier": "gke-production",
  "name": "GKE Production Cluster",
  "integration": "google-cloud-integration",
  "cluster": "production-cluster",
  "region": "us-central1",
  "project_id": "my-gcp-project",
  "zone": "us-central1-a",
  "tags": [
    "kubernetes",
    "gcp",
    "production"
  ]
}'

STATUS
201 Created