Edit with YAML

PATCH
/workspaces
/:workspace
/projects
/:project_name
/pipelines
/:pipeline_id
/yaml

Request

REQUIRED SCOPES

WORKSPACE, EXECUTION_MANAGE

URL PARAMETERS

workspacerequired string

The workspace name.

project_namerequired string

The name ID of the project.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

POST PARAMETERS

yamlrequired string

base64 encoded yaml definition of a pipeline

Last modified on Apr 11, 2025

Edit Delete

Example:

curl -X PATCH "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/yaml" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "yaml": "LSBwaXBlbGluZTogIkV4YW1wbGUgcGlwZWxpbmUiCiAgdHJpZ2dlcl9tb2RlOiAiTUFOVUFMIgogIHJlZl9uYW1lOiAibWFzdGVyIgogIHJlZl90eXBlOiAiQlJBTkNIIgogIHRyaWdnZXJfY29uZGl0aW9uOiAiQUxXQVlTIgogIGFjdGlvbnM6CiAgLSBhY3Rpb246ICJGaW5kICYgcmVwbGFjZSIKICAgIHR5cGU6ICJSRVBMQUNFIgogICAgbG9jYWxfcGF0aDogImRvY3MudHh0IgogICAgcmVwbGFjZW1lbnRzOgogICAgLSByZXBsYWNlX2Zyb206ICJuYW1lMTIzIgogICAgICByZXBsYWNlX3RvOiAibmFtZTMyMSIKICAgIHRyaWdnZXJfY29uZGl0aW9uOiAiQUxXQVlTIgotIHBpcGVsaW5lOiAiRXhhbXBsZSBwaXBlbGluZSAyIgogIHRyaWdnZXJfbW9kZTogIk1BTlVBTCIKICByZWZfbmFtZTogIm1hc3RlciIKICByZWZfdHlwZTogIkJSQU5DSCIKICB0cmlnZ2VyX2NvbmRpdGlvbjogIkFMV0FZUyIKICBhY3Rpb25zOgogIC0gYWN0aW9uOiAiU2xlZXAgMTUgc2Vjb25kcyIKICAgIHR5cGU6ICJTTEVFUCIKICAgIHNsZWVwX2luX3NlYzogMTUKICAgIHRyaWdnZXJfY29uZGl0aW9uOiAiQUxXQVlTIgo="
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/company/projects/company-website/pipelines",
  "html_url": "https://api.buddy.works/company/company-website/pipelines",
  "yaml": "LSBwaXBlbGluZTogIkV4YW1wbGUgcGlwZWxpbmUiCiAgdHJpZ2dlcl9tb2RlOiAiTUFOVUFMIgogIHJlZl9uYW1lOiAibWFzdGVyIgogIHJlZl90eXBlOiAiQlJBTkNIIgogIHRyaWdnZXJfY29uZGl0aW9uOiAiQUxXQVlTIgogIGFjdGlvbnM6CiAgLSBhY3Rpb246ICJGaW5kICYgcmVwbGFjZSIKICAgIHR5cGU6ICJSRVBMQUNFIgogICAgbG9jYWxfcGF0aDogImRvY3MudHh0IgogICAgcmVwbGFjZW1lbnRzOgogICAgLSByZXBsYWNlX2Zyb206ICJuYW1lMTIzIgogICAgICByZXBsYWNlX3RvOiAibmFtZTMyMSIKICAgIHRyaWdnZXJfY29uZGl0aW9uOiAiQUxXQVlTIgotIHBpcGVsaW5lOiAiRXhhbXBsZSBwaXBlbGluZSAyIgogIHRyaWdnZXJfbW9kZTogIk1BTlVBTCIKICByZWZfbmFtZTogIm1hc3RlciIKICByZWZfdHlwZTogIkJSQU5DSCIKICB0cmlnZ2VyX2NvbmRpdGlvbjogIkFMV0FZUyIKICBhY3Rpb25zOgogIC0gYWN0aW9uOiAiU2xlZXAgMTUgc2Vjb25kcyIKICAgIHR5cGU6ICJTTEVFUCIKICAgIHNsZWVwX2luX3NlYzogMTUKICAgIHRyaWdnZXJfY29uZGl0aW9uOiAiQUxXQVlTIgo="
}

STATUS
200 OK

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