Docs
View as Markdown

gitlab.pipelines

stable Advanced

Recent CI pipelines of a public GitLab.com project.

GET /v1/gitlab/pipelines

What you get#

A list of GitLab results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
projectstringyes(required)Project path (group/project) or numeric idmax 200 chars; must match [A-Za-z0-9_][A-Za-z0-9_.-]*(?:/[A-Za-z0-9_][A-Za-z0-9_.-]*)*; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/gitlab/pipelines?project=gitlab-org%2Fgitlab" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real GitLab response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "content": {
        "id": "2890903071",
        "state": "running",
        "url": "https://gitlab.com/gitlab-org/gitlab/-/pipelines/2890903071",
        "createdAt": "2026-09-28T19:58:35Z",
        "updatedAt": "2026-09-28T19:58:38Z"
      },
      "ext": {
        "ref": "refs/merge-requests/257853/merge",
        "sha": "18e99fc9538d065b0abda0b81468b3b23ce0d557"
      }
    },
    {
      "content": {
        "id": "2890902934",
        "state": "running",
        "url": "https://gitlab.com/gitlab-org/gitlab/-/pipelines/2890902934",
        "createdAt": "2026-09-28T19:58:31Z",
        "updatedAt": "2026-09-28T19:58:35Z"
      },
      "ext": {
        "ref": "refs/merge-requests/257949/merge",
        "sha": "bfb06a9a12465e0402ba3ea41b76750ba5cced40"
      }
    }
  ],
  "metadata": {
    "platform": "gitlab",
    "endpoint": "pipelines",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
idcontent.idtoString
statuscontent.state-
refext.ref-
shaext.sha-
web_urlcontent.urlsafeUrl
created_atcontent.createdAttoIsoDate
updated_atcontent.updatedAttoIsoDate

Caching and freshness#

  • Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
  • Between 30 seconds and 5 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 10 minutes more (marked stale).
  • A "not found" is remembered for 1 minute and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).