--- title: "A pipeline - its configuration (pipeline.yml) and its builds" description: "The configuration is the service's (Buildkite's pipeline YAML, as set\nin Buildkite), read at most every 5 minutes. A pipeline that uploads\nits steps from the repo shows the upload step here; the repo's own\nfile is on the Code tab. When the read fails, the last copy is\nshown with `configuration_error`.\n" --- > Documentation Index > Fetch the complete documentation index at: https://docs.gitpando.com/llms.txt > Use this file to discover all available pages before exploring further. Path: Pando API › ci `GET /v1/monorepos/{owner}/{monorepo}/ci/pipelines/{pipeline}` The configuration is the service's (Buildkite's pipeline YAML, as set in Buildkite), read at most every 5 minutes. A pipeline that uploads its steps from the repo shows the upload step here; the repo's own file is on the Code tab. When the read fails, the last copy is shown with `configuration_error`. ## Authentication Requires one of the following: - `credential`, http, header `Authorization` - `session`, apiKey, in cookie ## Path parameters - `getCiPipeline.path.owner` (string, required) — The monorepo's owner, a namespace (a person's login or an organization). Matched without case. - pattern `^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$` - `getCiPipeline.path.monorepo` (string, required) — The monorepo's name within its owner (or an old name). Matched without case. - pattern `^[a-z0-9](?:[a-z0-9._]|-(?!-)){0,38}$` - `getCiPipeline.path.pipeline` (string, required) ## Query parameters - `getCiPipeline.query.connection` (string, optional) — Needed only when two connections have a pipeline of this name. - `getCiPipeline.query.limit` (integer, optional) - min 1; max 100; default `30` - `getCiPipeline.query.cursor` (string, optional) ## Code samples ### cURL ```curl curl --request GET \ --url https://app.gitpando.com/v1/monorepos/string/string/ci/pipelines/string \ --header 'Authorization: Bearer ' ``` ### TypeScript ```typescript const url = 'https://app.gitpando.com/v1/monorepos/string/string/ci/pipelines/string'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err)); ``` ### Python ```python import requests url = "https://app.gitpando.com/v1/monorepos/string/string/ci/pipelines/string" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.text) ``` ## Responses ### 200 OK #### Example ```json { "pipeline": { "connection": "string", "service": "string", "slug": "string", "name": "string", "repo": "string", "repo_path": "string", "web_url": "string", "default_branch": "string", "hook_id": "string", "required_checks": [ "string" ], "last_build": { "id": "string", "service": "string", "connection": "string", "pipeline": "string", "number": 0, "repo": "string", "repo_path": "string", "sha": "string", "branch": "string", "message": "string", "state": "queued", "service_state": "string", "web_url": "string", "pushed_by": "string", "created_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "duration_s": 0, "rebuilt_from": "string" }, "configuration": "string", "configuration_fetched_at": "2019-08-24T14:15:22Z", "configuration_error": { "code": "string", "message": "string" } }, "builds": [ { "id": "string", "service": "string", "connection": "string", "pipeline": "string", "number": 0, "repo": "string", "repo_path": "string", "sha": "string", "branch": "string", "message": "string", "state": "queued", "service_state": "string", "web_url": "string", "pushed_by": "string", "created_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "duration_s": 0, "rebuilt_from": "string" } ], "next_cursor": "string" } ``` - `getCiPipeline.response.200.pipeline` (object, required) - `getCiPipeline.response.200.pipeline.connection` (string, required) - `getCiPipeline.response.200.pipeline.service` (string, required) - `getCiPipeline.response.200.pipeline.slug` (string, required) - `getCiPipeline.response.200.pipeline.name` (string, required) - `getCiPipeline.response.200.pipeline.repo` (string | null, required) — The repo it builds. - `getCiPipeline.response.200.pipeline.web_url` (string, required) - `getCiPipeline.response.200.pipeline.last_build` (one of, required) - one of: [CiBuild](/api/schemas/CiBuild/), `null` - `getCiPipeline.response.200.pipeline.repo_path` (string | null, optional) - `getCiPipeline.response.200.pipeline.default_branch` (string | null, optional) - `getCiPipeline.response.200.pipeline.hook_id` (string | null, optional) — The buildkite hook that starts its builds on push, if any. - `getCiPipeline.response.200.pipeline.required_checks` (array | null, optional) — Its repo's required checks (from `.pando/pando.toml`); null while unknown. - `getCiPipeline.response.200.pipeline.configuration` (string | null, optional) - `getCiPipeline.response.200.pipeline.configuration_fetched_at` (string | null, optional) - format `date-time` - `getCiPipeline.response.200.pipeline.configuration_error` (object | null, optional) - `getCiPipeline.response.200.pipeline.configuration_error.code` (string, optional) - `getCiPipeline.response.200.pipeline.configuration_error.message` (string, optional) - `getCiPipeline.response.200.builds` (array, required) - `getCiPipeline.response.200.builds.id` (string, required) — Pando's id (`cib_...`). - `getCiPipeline.response.200.builds.service` (string, required) - `getCiPipeline.response.200.builds.connection` (string, required) - `getCiPipeline.response.200.builds.pipeline` (string, required) - `getCiPipeline.response.200.builds.number` (integer, required) - `getCiPipeline.response.200.builds.repo` (string, required) - `getCiPipeline.response.200.builds.sha` (string | null, required) — Null when the service built no fixed commit. - `getCiPipeline.response.200.builds.state` (string, required) — One vocabulary for every service. Buildkite's scheduled and waiting are queued, failing and canceling are running, not_run and broken are skipped; `service_state` keeps the service's own word. - one of `"queued"`, `"running"`, `"blocked"`, `"passed"`, `"failed"`, `"canceled"`, `"skipped"` - `getCiPipeline.response.200.builds.service_state` (string, required) - `getCiPipeline.response.200.builds.created_at` (string | null, required) - format `date-time` - `getCiPipeline.response.200.builds.repo_path` (string | null, optional) - `getCiPipeline.response.200.builds.branch` (string | null, optional) - `getCiPipeline.response.200.builds.message` (string | null, optional) - `getCiPipeline.response.200.builds.web_url` (string | null, optional) - `getCiPipeline.response.200.builds.pushed_by` (string | null, optional) — Who pushed the commit (a login), from Pando's own records; never the service's creator. - `getCiPipeline.response.200.builds.started_at` (string | null, optional) - format `date-time` - `getCiPipeline.response.200.builds.finished_at` (string | null, optional) - format `date-time` - `getCiPipeline.response.200.builds.duration_s` (integer | null, optional) - `getCiPipeline.response.200.builds.rebuilt_from` (string | null, optional) — The service's id of the build this one rebuilt. - `getCiPipeline.response.200.next_cursor` (string | null, required) ### 404 An error #### Example ```json { "error": { "code": "string", "message": "string", "paths": [ "string" ], "checks": { "sha": "string", "state": "success", "required": [ "string" ], "checks_unknown": "string", "missing": [ "string" ], "statuses": [ { "sha": "string", "context": "string", "state": "pending", "target_url": "string", "description": "string", "creator": "string", "app": "string", "created_at": "2019-08-24T14:15:22Z" } ] } } } ``` - `getCiPipeline.response.404.error` (object, required) - `getCiPipeline.response.404.error.code` (string, required) - `getCiPipeline.response.404.error.message` (string, required) - `getCiPipeline.response.404.error.paths` (array, optional) - `getCiPipeline.response.404.error.checks` (object, optional) — GitHub's combined status, plus the required contexts and which are missing. - `getCiPipeline.response.404.error.checks.sha` (string | null, required) - `getCiPipeline.response.404.error.checks.state` (string, required) — `success` when the merge gate passes; `missing` when a required context has not reported; `unknown` while the required checks are (an unforced merge is refused). - one of `"success"`, `"pending"`, `"failure"`, `"error"`, `"missing"`, `"unknown"` - `getCiPipeline.response.404.error.checks.required` (array | null, required) — Null while unknown. - `getCiPipeline.response.404.error.checks.checks_unknown` (string | null, required) — Why the required checks are unknown, in plain words: "Pando couldn't read this monorepo's required checks; try again", or "pando.toml line 3: expected comma or end of structure; fix it on main, or merge with force". Null otherwise. - `getCiPipeline.response.404.error.checks.statuses` (array, required) — The latest status per context. - `getCiPipeline.response.404.error.checks.statuses.sha` (string, required) - `getCiPipeline.response.404.error.checks.statuses.context` (string, required) - `getCiPipeline.response.404.error.checks.statuses.state` (string, required) - one of `"pending"`, `"success"`, `"failure"`, `"error"` - `getCiPipeline.response.404.error.checks.statuses.created_at` (string, required) - format `date-time` - `getCiPipeline.response.404.error.checks.statuses.target_url` (string | null, optional) - `getCiPipeline.response.404.error.checks.statuses.description` (string | null, optional) - `getCiPipeline.response.404.error.checks.statuses.creator` (string, optional) — The member who posted it (a login); `app:` for a status posted with a status token or by a CI integration; `hook:` for a status token from a web hook with no app. - `getCiPipeline.response.404.error.checks.statuses.app` (string | null, optional) — The CI service that reported it (`buildkite`, `github-actions`, ...), stamped by Pando from a status token or a CI integration, never from the body or `target_url`. Null when a member posted it with their own credential. The web shows the service's mark for a slug it knows. - `getCiPipeline.response.404.error.checks.missing` (array, optional) ### 409 An error #### Example ```json { "error": { "code": "string", "message": "string", "paths": [ "string" ], "checks": { "sha": "string", "state": "success", "required": [ "string" ], "checks_unknown": "string", "missing": [ "string" ], "statuses": [ { "sha": "string", "context": "string", "state": "pending", "target_url": "string", "description": "string", "creator": "string", "app": "string", "created_at": "2019-08-24T14:15:22Z" } ] } } } ``` - `getCiPipeline.response.409.error` (object, required) - `getCiPipeline.response.409.error.code` (string, required) - `getCiPipeline.response.409.error.message` (string, required) - `getCiPipeline.response.409.error.paths` (array, optional) - `getCiPipeline.response.409.error.checks` (object, optional) — GitHub's combined status, plus the required contexts and which are missing. - `getCiPipeline.response.409.error.checks.sha` (string | null, required) - `getCiPipeline.response.409.error.checks.state` (string, required) — `success` when the merge gate passes; `missing` when a required context has not reported; `unknown` while the required checks are (an unforced merge is refused). - one of `"success"`, `"pending"`, `"failure"`, `"error"`, `"missing"`, `"unknown"` - `getCiPipeline.response.409.error.checks.required` (array | null, required) — Null while unknown. - `getCiPipeline.response.409.error.checks.checks_unknown` (string | null, required) — Why the required checks are unknown, in plain words: "Pando couldn't read this monorepo's required checks; try again", or "pando.toml line 3: expected comma or end of structure; fix it on main, or merge with force". Null otherwise. - `getCiPipeline.response.409.error.checks.statuses` (array, required) — The latest status per context. - `getCiPipeline.response.409.error.checks.statuses.sha` (string, required) - `getCiPipeline.response.409.error.checks.statuses.context` (string, required) - `getCiPipeline.response.409.error.checks.statuses.state` (string, required) - one of `"pending"`, `"success"`, `"failure"`, `"error"` - `getCiPipeline.response.409.error.checks.statuses.created_at` (string, required) - format `date-time` - `getCiPipeline.response.409.error.checks.statuses.target_url` (string | null, optional) - `getCiPipeline.response.409.error.checks.statuses.description` (string | null, optional) - `getCiPipeline.response.409.error.checks.statuses.creator` (string, optional) — The member who posted it (a login); `app:` for a status posted with a status token or by a CI integration; `hook:` for a status token from a web hook with no app. - `getCiPipeline.response.409.error.checks.statuses.app` (string | null, optional) — The CI service that reported it (`buildkite`, `github-actions`, ...), stamped by Pando from a status token or a CI integration, never from the body or `target_url`. Null when a member posted it with their own credential. The web shows the service's mark for a slug it knows. - `getCiPipeline.response.409.error.checks.missing` (array, optional) Source: https://docs.gitpando.com/api/ci/getCiPipeline/index.md