Edit target with YAML

PATCH
/workspaces
/:workspace
/targets
/:target_id
/yaml

Update an existing target by sending a new YAML definition. The PATCH request applies the YAML payload to the target configuration.

Request

REQUIRED SCOPES

TARGET_WRITE

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

target_idrequiredstring

Target unique identifier (hash ID)

Example: "tgt-1234567890abcdef"

BODY PARAMETERS

yamlstring

The Base64-encoded YAML definition of the target

Response

RESPONSE BODY

variantsvariants

Type-specific parameters based on discriminator value

Last modified on Aug 18, 2026

Export target List target executions

Request example


curl -X PATCH "https://api.buddy.works/workspaces/:workspace/targets/:target_id/yaml" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "yaml": "LSB0YXJnZXQ6..."
}'