Export

GET
/workspaces
/:domain
/projects
/:project_name
/pipelines
/:pipeline_id

Returns base64-encoded YAML with the details of the specified pipeline.

Request

REQUIRED SCOPES

WORKSPACE, EXECUTION_MANAGE

URL PARAMETERS

domainrequired string

The workspace domain.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

project_namerequired string

The name ID of the project.

yamlrequired boolean

Has to be set to true.

Last modified on Oct 7, 2024

Clear cache Build application

Example: Exporting all pipelines from a given project

CURL
  curl -X GET "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id" \
      -H "Authorization: Bearer <YOUR-TOKEN>" \
      -H "Content-Type: application/json" \

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

Example: Exporting a single pipeline from a given project

CURL
  curl -X GET "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id" \
      -H "Authorization: Bearer <YOUR-TOKEN>" \
      -H "Content-Type: application/json" \

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

STATUS
200 OK

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