Skip to content

The manually-dispatchable catalog at a ref (ADR-0043 §4). Resolves `ref` to a concrete commit (echoed back), enumerates every `.scarab/*.{yaml,yml}` at it (direct children only — `.scarab/lib/**` is excluded, mirroring webhook discovery), and reports each pipeline's `manual`/`api` opt-in from a **lightweight `on:`-only parse** (no `invoke:` pre-fetch, no full compile — that cost is deferred to the on-selection interface read). A single file that fails to parse is flagged with an `error` rather than failing the whole list; an absent `.scarab/` yields an empty catalog, not an error. Read capability.

GET
/v1/repos/{org}/{repo}/pipelines
curl --request GET \
--url https://example.com/v1/repos/example/example/pipelines
org
required
string

Repo owner

repo
required
string

Repo name

ref
string

Ref to read the config at (default HEAD)

Dispatch catalog at the resolved commit

Media typeapplication/json

GET /v1/repos/{org}/{repo}/pipelines?ref= body: the manually-dispatchable catalog at a ref (ADR-0043 §4). Lightweight — each entry is an on:-only read, not a full compile. sha is the ref resolved to a concrete commit.

object
pipelines
required

Every .scarab/*.{yaml,yml} at the commit (excluding .scarab/lib/**), path-sorted.

Array<object>

One pipeline in the dispatch catalog: its selection name and whether it opts into manual / api dispatch (its on: includes that trigger).

object
api
required

This pipeline declares on: api — its programmatic dispatch sibling.

boolean
error

Set when this single file failed to parse — the rest of the catalog still lists (a broken sibling does not fail the whole listing, ADR-0043 §4).

string | null
manual
required

This pipeline declares on: manual — it appears in the human catalog.

boolean
name
required

The bare selection name (e.g. deploy) — what a describe/dispatch call passes as pipeline.

string
sha
required

The ref resolved to a concrete commit — the catalog reflects this exact commit, and a subsequent describe/dispatch should pin to it.

string
Examplegenerated
{
"pipelines": [
{
"api": true,
"error": "example",
"manual": true,
"name": "example"
}
],
"sha": "example"
}