Export pipeline

Returns base64-encoded YAML.

Required scopes: WORKSPACE, EXECUTION_MANAGE

Resource URL

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

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.
pipeline_id
Required
IntegerThe numerical ID of the desired pipeline.
project_name
Required
StringThe name ID of the project.
yaml
Required
BooleanHas to be set to true.

Example for exporting all pipelines from a given project

Request

GET http://api.buddy.works/workspaces/buddy/projects/company-website/pipelines?yaml=True

Sample Response

HTTP

Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

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

Example for exporting a single pipeline from a given project

Request

GET http://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1?yaml=True

Sample Response

HTTP

Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"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="
}