---
title: "The CI tab's top - services, connections, pipelines, required checks"
---

> 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`

## Authentication

Requires one of the following:

- `credential`, http, header `Authorization`
- `session`, apiKey, in cookie

## Path parameters

- `getCi.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}$`
- `getCi.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}$`

## Code samples

### cURL

```curl
curl --request GET \
  --url https://app.gitpando.com/v1/monorepos/string/string/ci \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://app.gitpando.com/v1/monorepos/string/string/ci';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

OK

#### Example

```json
{
  "services": [
    {
      "service": "string",
      "name": "string"
    }
  ],
  "connections": [
    {
      "id": "string",
      "service": "buildkite",
      "organization": "string",
      "web_url": "string",
      "webhook_url": "string",
      "token": "worker_secret",
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": "string",
      "last_event": {
        "at": "2019-08-24T14:15:22Z",
        "event": "string",
        "result": "string"
      },
      "last_refused": {
        "at": "2019-08-24T14:15:22Z",
        "reason": "string"
      }
    }
  ],
  "pipelines": [
    {
      "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"
      }
    }
  ],
  "required_checks": [
    {
      "repo": "string",
      "path": "string",
      "checks": [
        "string"
      ]
    }
  ]
}
```

- `getCi.response.200.services` (array<object>, required) — The services Pando can connect.
  - `getCi.response.200.services.service` (string, optional)
  - `getCi.response.200.services.name` (string, optional)
- `getCi.response.200.connections` (array<object>, required)
  - `getCi.response.200.connections.id` (string, required)
  - `getCi.response.200.connections.service` (string, required)
    - one of `"buildkite"`
  - `getCi.response.200.connections.organization` (string, required)
  - `getCi.response.200.connections.web_url` (string, required) — The organization on the service.
  - `getCi.response.200.connections.webhook_url` (string, required) — The URL to paste into the service's webhook settings.
  - `getCi.response.200.connections.token` (string, required) — Where its REST token comes from: the Worker secret BUILDKITE_API_TOKEN at launch.
    - one of `"worker_secret"`, `"stored"`
  - `getCi.response.200.connections.created_at` (string, required)
    - format `date-time`
  - `getCi.response.200.connections.created_by` (string, required)
  - `getCi.response.200.connections.last_event` (object | null, required) — The last webhook that passed its check.
    - `getCi.response.200.connections.last_event.at` (string, optional)
      - format `date-time`
    - `getCi.response.200.connections.last_event.event` (string | null, optional)
    - `getCi.response.200.connections.last_event.result` (string | null, optional) — `recorded`, or `ignored: <reason>`.
  - `getCi.response.200.connections.last_refused` (object | null, required) — The last webhook refused (a wrong token or signature), recorded at most every 10 s.
    - `getCi.response.200.connections.last_refused.at` (string, optional)
      - format `date-time`
    - `getCi.response.200.connections.last_refused.reason` (string | null, optional)
- `getCi.response.200.pipelines` (array<object>, required) — Each connection's pipelines - those its builds named, and those a buildkite hook names.
  - `getCi.response.200.pipelines.connection` (string, required)
  - `getCi.response.200.pipelines.service` (string, required)
  - `getCi.response.200.pipelines.slug` (string, required)
  - `getCi.response.200.pipelines.name` (string, required)
  - `getCi.response.200.pipelines.repo` (string | null, required) — The repo it builds.
  - `getCi.response.200.pipelines.web_url` (string, required)
  - `getCi.response.200.pipelines.last_build` (one of, required)
    - one of: [CiBuild](/api/schemas/CiBuild/), `null`
  - `getCi.response.200.pipelines.repo_path` (string | null, optional)
  - `getCi.response.200.pipelines.default_branch` (string | null, optional)
  - `getCi.response.200.pipelines.hook_id` (string | null, optional) — The buildkite hook that starts its builds on push, if any.
  - `getCi.response.200.pipelines.required_checks` (array | null, optional) — Its repo's required checks (from `.pando/pando.toml`); null while unknown.
- `getCi.response.200.required_checks` (array<object>, required) — Every repo's required checks, read from `.pando/pando.toml` (a repo with no pipeline is here too).
  - `getCi.response.200.required_checks.repo` (string, optional)
  - `getCi.response.200.required_checks.path` (string, optional)
  - `getCi.response.200.required_checks.checks` (array | null, optional) — Null while unknown (pando.toml unreadable or broken).

### 403

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"
        }
      ]
    }
  }
}
```

- `getCi.response.403.error` (object, required)
  - `getCi.response.403.error.code` (string, required)
  - `getCi.response.403.error.message` (string, required)
  - `getCi.response.403.error.paths` (array<string>, optional)
  - `getCi.response.403.error.checks` (object, optional) — GitHub's combined status, plus the required contexts and which are missing.
    - `getCi.response.403.error.checks.sha` (string | null, required)
    - `getCi.response.403.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"`
    - `getCi.response.403.error.checks.required` (array | null, required) — Null while unknown.
    - `getCi.response.403.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.
    - `getCi.response.403.error.checks.statuses` (array<object>, required) — The latest status per context.
      - `getCi.response.403.error.checks.statuses.sha` (string, required)
      - `getCi.response.403.error.checks.statuses.context` (string, required)
      - `getCi.response.403.error.checks.statuses.state` (string, required)
        - one of `"pending"`, `"success"`, `"failure"`, `"error"`
      - `getCi.response.403.error.checks.statuses.created_at` (string, required)
        - format `date-time`
      - `getCi.response.403.error.checks.statuses.target_url` (string | null, optional)
      - `getCi.response.403.error.checks.statuses.description` (string | null, optional)
      - `getCi.response.403.error.checks.statuses.creator` (string, optional) — The member who posted it (a login); `app:<slug>` for a status posted with a status token or by a CI integration; `hook:<hook id>` for a status token from a web hook with no app.
      - `getCi.response.403.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.
    - `getCi.response.403.error.checks.missing` (array<string>, optional)


Source: https://docs.gitpando.com/api/ci/getCi/index.md