Edit

PATCH
/workspaces
/:workspace
/targets
/:target_id

Edits a Elastic Kubernetes Service Target.

Request

REQUIRED SCOPES

WORKSPACE, TARGET_ADD

URL PARAMETERS

workspacerequired string

The workspace name.

POST PARAMETERS

namerequired string

The name of the target

identifierrequired string

Readable ID for target. It can consist of uppercase and lowercase letters, numbers, and underscores. It must start with a letter.

integrationrequired string

Identifier of the integration.

clusterrequired string

Address of the cluster.

regionrequired string

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

role_arnstring

Amazon resource name specifying the role.

projectproject

Set this if you want to add the target to a project. Must contain field name (string).

pipelinepipeline

Set this if you want to add the target to a pipeline. Must contain field id (integer).

environmentenvironment

Set this if you want to add the target to an environment. Must contain field id (string).

permissionsPipelinePermissions

Define to set permissions for the target.

pathstring

Path on the server defined in the target.

disabledboolean

When set to true the target is disabled. By default it is set to false.

tagsstring[]

A list of tags associated with the target.

Last modified on Sep 9, 2025

Create Create

Example:

curl -X PATCH "https://api.buddy.works/workspaces/:workspace/targets/:target_id" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "id": "tg-u0t7lns1iymq3",
  "identifier": "eks_workspace",
  "tags": [
    "orange",
    "rabsperry",
    "olive"
  ],
  "name": "EKS WORKSPACE",
  "integration": "AMAZON_DEFAULT_group",
  "cluster": "https://192.168.5.226:6443",
  "region": "eu-central-1",
  "role_arn": "arn:aws:iam::123456789012:role/eks-cluster-service-role",
  "type": "EKS"
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/targets/tg-tkeoqrx7shvrd",
  "html_url": "https://app.buddy.works/buddy/-/targets/tg-tkeoqrx7shvrd/edit",
  "id": "tg-tkeoqrx7shvrd",
  "identifier": "eks_workspace",
  "permissions": {
    "others": "USE_ONLY",
    "users": [
      {
        "id": 1,
        "access_level": "MANAGE"
      }
    ]
  },
  "tags": [
    "orange",
    "rabsperry",
    "olive"
  ],
  "name": "EKS WORKSPACE",
  "integration": "AMAZON_DEFAULT_group",
  "cluster": "https://192.168.5.226:6443",
  "region": "eu-central-1",
  "role_arn": "arn:aws:iam::123456789012:role/eks-cluster-service-role",
  "type": "EKS"
}

STATUS
200 OK

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999