Create

POST
/workspaces
/:workspace
/targets

Creates a new kubernetes cluster target in the project.

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.

typerequired String

The type of the target. For AKS use AKS.

integrationrequired string

Identifier of the integration.

clusterrequired string

Address of the cluster.

authrequired string

Kubernetes cluster authentication method.

projectstring

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

pipelineinteger

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

environmentstring

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

Edit Edit

Example:

curl -X POST "https://api.buddy.works/workspaces/:workspace/targets" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "id": "tg-ypfw2tpfm5i4p",
  "identifier": "k8s_cluster_workspace",
  "tags": [],
  "name": "K8S_CLUSTER WORKSPACE",
  "cluster": "https://192.168.5.226:6443",
  "auth": {
    "method": "TOKEN",
    "token": "!encrypted 9834+V/D7lXE/OhoVor4rd4R+VRBxaG33ZZ9ciZLs3z/12s6WETH27xoi/mWcl5E.aW1crlXL9VMXb8mJjT6YKA=="
  },
  "type": "K8S_CLUSTER"
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/targets/tg-aqtucqx1agenv",
  "html_url": "https://app.buddy.works/buddy/-/targets/tg-aqtucqx1agenv/edit",
  "id": "tg-aqtucqx1agenv",
  "identifier": "k8s_cluster_workspace",
  "permissions": {
    "others": "USE_ONLY",
    "users": [
      {
        "id": 1,
        "access_level": "MANAGE"
      }
    ]
  },
  "name": "K8S_CLUSTER WORKSPACE",
  "cluster": "https://192.168.5.226:6443",
  "auth": {
    "method": "TOKEN",
    "token": "!encrypted 9834+V/D7lXE/OhoVor4rd4R+VRBxaG33ZZ9ciZLs3z/12s6WETH27xoi/mWcl5E.aW1crlXL9VMXb8mJjT6YKA=="
  },
  "type": "K8S_CLUSTER"
}

STATUS
200 OK

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