View

Learn how to inspect a pipeline.

Endpoint

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

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

Permissions

COMING SOON!

Responses

Status Code	Description
`200`	indicates the request has succeeded
`400`	unable to retrieve the pipeline configuration
`401`	indicates the user does not have proper permissions
`404`	unable to retrieve the pipeline configuration

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"

Response

{
  "id": 1,
  "repo_id": 1,
  "commit": "48afb5bdc41ad69bf22588491333f7cf71135163",
  "flavor": "",
  "platform": "",
  "ref": "refs/heads/main",
  "type": "yaml",
  "version": "1",
  "external_secrets": false,
  "internal_secrets": false,
  "services": false,
  "stages": false,
  "steps": true,
  "templates": false,
  "data": "LS0tCnZlcnNpb246ICIxIgoKc3RlcHM6CiAgLSBuYW1lOiBlY2hvCiAgICBpbWFnZTogYWxwaW5lOmxhdGVzdAogICAgY29tbWFuZHM6IFtlY2hvIGZvb10="
}

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