--- title: "A build's annotations, from the service (first 100)" --- > 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/builds/{build}/annotations` ## Authentication Requires one of the following: - `credential`, http, header `Authorization` - `session`, apiKey, in cookie ## Path parameters - `listCiAnnotations.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}$` - `listCiAnnotations.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}$` - `listCiAnnotations.path.build` (string, required) — Pando's build id (`cib_<16 hex>`). ## Code samples ### cURL ```curl curl --request GET \ --url https://app.gitpando.com/v1/monorepos/string/string/ci/builds/string/annotations \ --header 'Authorization: Bearer ' ``` ### TypeScript ```typescript const url = 'https://app.gitpando.com/v1/monorepos/string/string/ci/builds/string/annotations'; 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/builds/string/annotations" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.text) ``` ## Responses ### 200 OK #### Example ```json { "annotations": [ { "id": "string", "context": "string", "style": "string", "body_html": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "truncated": true, "complete": true, "fetched_at": "2019-08-24T14:15:22Z", "cached": true, "retry_after_ms": 0 } ``` - `listCiAnnotations.response.200.annotations` (array, required) - `listCiAnnotations.response.200.annotations.id` (string | null, optional) - `listCiAnnotations.response.200.annotations.context` (string | null, optional) - `listCiAnnotations.response.200.annotations.style` (string | null, optional) — success, info, warning or error. - `listCiAnnotations.response.200.annotations.body_html` (string, optional) — HTML a pipeline wrote: sanitise it before showing it. - `listCiAnnotations.response.200.annotations.created_at` (string | null, optional) - format `date-time` - `listCiAnnotations.response.200.annotations.updated_at` (string | null, optional) - format `date-time` - `listCiAnnotations.response.200.truncated` (boolean, required) — The build has more than 100. - `listCiAnnotations.response.200.complete` (boolean, required) - `listCiAnnotations.response.200.fetched_at` (string, required) - format `date-time` - `listCiAnnotations.response.200.cached` (boolean, required) - `listCiAnnotations.response.200.retry_after_ms` (integer | null, required) — Set when this is the last copy because Buildkite's rate limit is held: ask again after this long. Null otherwise. ### 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" } ] } } } ``` - `listCiAnnotations.response.404.error` (object, required) - `listCiAnnotations.response.404.error.code` (string, required) - `listCiAnnotations.response.404.error.message` (string, required) - `listCiAnnotations.response.404.error.paths` (array, optional) - `listCiAnnotations.response.404.error.checks` (object, optional) — GitHub's combined status, plus the required contexts and which are missing. - `listCiAnnotations.response.404.error.checks.sha` (string | null, required) - `listCiAnnotations.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"` - `listCiAnnotations.response.404.error.checks.required` (array | null, required) — Null while unknown. - `listCiAnnotations.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. - `listCiAnnotations.response.404.error.checks.statuses` (array, required) — The latest status per context. - `listCiAnnotations.response.404.error.checks.statuses.sha` (string, required) - `listCiAnnotations.response.404.error.checks.statuses.context` (string, required) - `listCiAnnotations.response.404.error.checks.statuses.state` (string, required) - one of `"pending"`, `"success"`, `"failure"`, `"error"` - `listCiAnnotations.response.404.error.checks.statuses.created_at` (string, required) - format `date-time` - `listCiAnnotations.response.404.error.checks.statuses.target_url` (string | null, optional) - `listCiAnnotations.response.404.error.checks.statuses.description` (string | null, optional) - `listCiAnnotations.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. - `listCiAnnotations.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. - `listCiAnnotations.response.404.error.checks.missing` (array, optional) ### 503 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" } ] } } } ``` - `listCiAnnotations.response.503.error` (object, required) - `listCiAnnotations.response.503.error.code` (string, required) - `listCiAnnotations.response.503.error.message` (string, required) - `listCiAnnotations.response.503.error.paths` (array, optional) - `listCiAnnotations.response.503.error.checks` (object, optional) — GitHub's combined status, plus the required contexts and which are missing. - `listCiAnnotations.response.503.error.checks.sha` (string | null, required) - `listCiAnnotations.response.503.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"` - `listCiAnnotations.response.503.error.checks.required` (array | null, required) — Null while unknown. - `listCiAnnotations.response.503.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. - `listCiAnnotations.response.503.error.checks.statuses` (array, required) — The latest status per context. - `listCiAnnotations.response.503.error.checks.statuses.sha` (string, required) - `listCiAnnotations.response.503.error.checks.statuses.context` (string, required) - `listCiAnnotations.response.503.error.checks.statuses.state` (string, required) - one of `"pending"`, `"success"`, `"failure"`, `"error"` - `listCiAnnotations.response.503.error.checks.statuses.created_at` (string, required) - format `date-time` - `listCiAnnotations.response.503.error.checks.statuses.target_url` (string | null, optional) - `listCiAnnotations.response.503.error.checks.statuses.description` (string | null, optional) - `listCiAnnotations.response.503.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. - `listCiAnnotations.response.503.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. - `listCiAnnotations.response.503.error.checks.missing` (array, optional) Source: https://docs.gitpando.com/api/ci/listCiAnnotations/index.md