v5

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-015725.9 KB
builds

List Builds

Return a paginated list of builds, newest first.

The status filter matches builds by an effective status derived from the build's lifecycle (never stored), drawn from a six-value vocabulary:

  • pending: accepted but not yet dispatched to a builder.
  • running: dispatched and building.
  • completed: finished successfully.
  • failed: finished unsuccessfully. Excludes timed-out builds, which match timed_out.
  • timed_out: terminated for exceeding its time budget.
  • cancelled: cancelled, whether before or after dispatch.

These six values are both the filter vocabulary and the response vocabulary: a timed-out build matches ?status=timed_out and reports status: "timed_out" in the response body.

Filters:

  • status: match one or more effective-status values.
  • system: match system names exactly. A name outside the server's system vocabulary returns 422 naming the accepted values, which are the systems this deployment's catalog holds and so may differ between deployments.
  • attr_path: match attr_path by prefix.
  • source_commit_sha: match source commit SHA by prefix.
  • since: return builds created at or after this time. An ISO 8601 timestamp carrying a UTC offset, e.g. 2026-07-17T08:30:00Z.

Filters combine with AND across parameters and OR within a repeated one: ?status=running&status=failed matches either status, and adding &system=x86_64-linux further requires that system. Each repeated parameter accepts at most 50 values.

cursor and sort are reserved for future use and have no effect in v1; results are always ordered newest-first.

get/api/v1/factory/builds

Query parameters

statusEffectiveBuildStatus[] nullable

Filter by effective status; repeatable, matched as OR. One of pending, running, completed, failed, timed_out, cancelled.

Filter by effective status; repeatable, matched as OR. One of pending, running, completed, failed, timed_out, cancelled.

systemstring[] nullable

Filter by system, matched exactly; repeatable, matched as OR. Values must be non-empty, and a value outside the server's system vocabulary returns 422 naming the accepted values.

Filter by system, matched exactly; repeatable, matched as OR. Values must be non-empty, and a value outside the server's system vocabulary returns 422 naming the accepted values.

attr_pathstring[] nullable

Filter by attr_path prefix; repeatable, matched as OR. Values must be non-empty.

Filter by attr_path prefix; repeatable, matched as OR. Values must be non-empty.

source_commit_shastring[] nullable

Filter by source commit SHA prefix; repeatable, matched as OR. Values must be non-empty.

Filter by source commit SHA prefix; repeatable, matched as OR. Values must be non-empty.

sincestring date-time nullable

Return builds created at or after this time (inclusive). An ISO 8601 timestamp carrying a UTC offset, e.g. '2026-07-17T08:30:00Z'.

Return builds created at or after this time (inclusive). An ISO 8601 timestamp carrying a UTC offset, e.g. '2026-07-17T08:30:00Z'.

pageinteger
page_sizeinteger
cursorstring nullable

Reserved for future use; not implemented in v1 (results are always ordered newest-first).

Reserved for future use; not implemented in v1 (results are always ordered newest-first).

sortstring nullable

Reserved for future use; not implemented in v1 (results are always ordered newest-first).

Reserved for future use; not implemented in v1 (results are always ordered newest-first).

Response

Successful Response

totalinteger required
pageinteger required
page_sizeinteger required
All 5 operations