Match

View as Markdown

POST
/workspaces
/:workspace
/targets
/yaml

Add target from YAML

Request

REQUIRED SCOPES

TARGET_ADD

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

GET PARAMETERS

project_namestring

Filter targets by project name

Example: "my-project"

pipeline_idinteger

Filter targets by pipeline ID

Example: 12345

environment_idstring

Filter targets by environment ID

Example: "67890"

BODY PARAMETERS

yamlstring

The Base64-encoded YAML definition of the target

Response

RESPONSE BODY

typestring

The type of the target

Value: MATCH

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)

notestring

Note for this resource

agent_notestring

YAML note for AI agents operating on this resource

scopestring enum

The scope of the target filter

Allowed enum:

WORKSPACE,

PROJECT,

ENVIRONMENT,

PIPELINE,

ACTION,

ANY

Last modified on Aug 13, 2026

Edit target Edit target with YAML

Request example

CURL
curl -X POST "https://api.buddy.works/workspaces/:workspace/targets/yaml" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json"

STATUS
201 Created