Templates

Learn how to list pipeline templates.

Endpoint

GET  /api/v1/pipelines/:org/:repo/:pipeline/templates

Parameters

The following parameters are used to configure the endpoint:

Name	Description
`org`	name of organization
`repo`	name of repository
`pipeline`	commit SHA for pipeline from repository
`output`	format the output for the compiled pipeline configuration

Permissions

COMING SOON!

Responses

Status Code	Description
`200`	indicates the request has succeeded
`400`	unable to retrieve the pipeline configuration templates
`401`	indicates the user does not have proper permissions
`404`	unable to retrieve the pipeline configuration or templates
`500`	system error while retrieving the pipeline configuration templates

Sample

This section assumes you already know how to authenticate to the API.

To authenticate to the API, please review the authentication documentation.

Request

curl \
  -X GET \
  -H "Authorization: Bearer <token>" \
  "http://127.0.0.1:8080/api/v1/pipelines/github/octocat/48afb5bdc41ad69bf22588491333f7cf71135163/templates"

Response

some_template:
  link: https://github.com/github/octocat/blob/main/template.yml
  name: some_template
  source: github.com/github/octocat/template.yml
  type: github

{
  "some_template": {
    "link": "https://github.com/github/octocat/blob/main/template.yml",
    "name": "some_template",
    "source": "github.com/github/octocat/template.yml",
    "type": "github"
  },
}

Last modified September 16, 2022: chore: use main as default (#324) (400aa851)