Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scrubbe.com/llms.txt

Use this file to discover all available pages before exploring further.

The pipelines API provides read-only access to CI/CD run history that the platform ingests automatically from your connected source control providers. When a pipeline run completes in GitHub Actions or GitLab CI, a webhook payload is delivered to the platform and stored as a structured run record. You can query this history to surface build trends, correlate deploys with incidents, or feed data into reporting dashboards — no manual data entry required. All requests require a Bearer token in the Authorization header.
Pipeline runs are created exclusively through GitHub and GitLab webhook ingestion. The API does not expose endpoints for creating, updating, or deleting run records.

​
List pipeline runs

GET https://your-api-domain.com/api/v1/pipelines Returns a paginated list of all ingested pipeline run records, ordered by start time descending (most recent first).

​
Query parameters

​
page
number
default:"1"
Page number for pagination.
​
limit
number
default:"25"
Number of records to return per page.
​
status
string
Filter by run status. Accepted values: success, failure, cancelled, in_progress.
​
provider
string
Filter by source provider. Accepted values: github, gitlab.
​
repository
string
Filter runs to a specific repository, in owner/repo format.
​
branch
string
Filter runs triggered from a specific branch.

​
Response fields

​
runs
object[]
required
Array of pipeline run summary objects.
​
pagination
object
required
Pagination metadata.
curl --request GET \
  --url 'https://your-api-domain.com/api/v1/pipelines?limit=25&status=failure&provider=github' \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
Get a pipeline run

GET https://your-api-domain.com/api/v1/pipelines/:id Returns the full detail record for a single pipeline run, including individual job or stage results if available in the webhook payload.

​
Path parameters

​
id
string
required
The unique identifier of the pipeline run record.

​
Response fields

​
id
string
required
Unique run record identifier.
​
provider
string
required
Source provider: github or gitlab.
​
repository
string
required
Repository in owner/repo format.
​
branch
string
required
Branch the pipeline ran against.
​
commitSha
string
required
Full SHA of the triggering commit.
​
commitMessage
string
The commit message associated with the triggering commit.
​
triggeredBy
string
Username or actor that triggered the pipeline.
​
status
string
required
Final run status: success, failure, cancelled, or in_progress.
​
startedAt
string
required
ISO 8601 timestamp when the run began.
​
finishedAt
string
ISO 8601 timestamp when the run completed. null if still in progress.
​
durationSeconds
number
Total run duration in seconds.
​
jobs
object[]
Individual job or stage results, if provided by the webhook payload.
​
rawPayload
object
The original webhook payload received from the provider, stored for auditability.
curl --request GET \
  --url https://your-api-domain.com/api/v1/pipelines/run_abc123 \
  --header 'Authorization: Bearer YOUR_TOKEN'