On this page
List builds
Lists builds in a project.
Lists builds in a project.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/builds - Scope
build:read - Effect
read— nothing is written. - Collection builds
- Query
page_size,page_token,filter,order_by - Pagination the answer carries
buildsand, when there is more,next_page_token
Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to list in. Required. |
page_size | int32 | At most this many; default 50, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
filter | string | AIP-160 filter over labels, filterable fields, and Ready. |
order_by | string | AIP-132 ordering over filterable fields. |
Response
| Field | Type | What it is |
|---|---|---|
builds | Build[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
Build
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/builds/{build}. |
uid | string | bld_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | BuildSpec | Desired state. Required. |
status | BuildStatus | Observed state. Output only. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
BuildSpec
| Field | Type | What it is |
|---|---|---|
source | BuildSource | A commit, read through the Broker at that exact commit. One of the input group. |
cache | string | The BuildCache to read and write; default the project's default cache. |
tree | BuildTree | A tree uploaded to the org's store, by its root digest. One of the input group. |
image | ImageTarget | An OCI image with an SBOM and signed provenance. One of the output group. |
command | CommandTarget | One command's exit code and the artifacts it names. One of the output group. |
size | BuildSize | The machine size; default [build] size, else STANDARD. One of standard, large, xlarge. |
timeout | duration | The time limit; default 1 hour, at most 6 hours. A command that reaches it is killed and the Build ends with BUILD_FAILURE_TIMEOUT. |
allow_hosts | string[] | Internet hosts the build may reach. Empty means in-cell only: the mirrors and the store. Default [build] allow_hosts. |
BuildStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
state | BuildState | The lifecycle state. Output only. One of queued, running, succeeded, failed, cancelled. |
failure | BuildFailure | Why the build failed, when state is FAILED. Output only. One of source_unavailable, build_error, no_capacity, class_not_offered, signing_unavailable, timeout, setup_failed. |
output | BuildOutput | The result: an image when state is SUCCEEDED; for a command, set whenever the command ran, whatever its exit code. Output only. |
lease | string | The Sandboxes lease the build ran on. Output only. |
start_time | timestamp | When the build started running. Output only. |
end_time | timestamp | When the build reached a final state. Output only. |
log_uri | string | Where the build log is read, through Observability. Output only. |
workspace | BuildWorkspace | Whether the build took a warm workspace of the same repository. Output only. One of warm, cold. |
bytes_up | int64 | Bytes the client uploaded for this build: the blobs of the tree the org's store lacked. Output only. |
BuildSource
| Field | Type | What it is |
|---|---|---|
source_link | string | The Hosting SourceLink naming the repository and its Connection. Required. |
commit | string | The full commit SHA to build. Required. |
root_directory | string | The directory inside the repository to build; default the root. |
BuildTree
| Field | Type | What it is |
|---|---|---|
root_digest | string | The root Directory digest, <sha256 hex>/<size in bytes>. Required. |
ImageTarget
| Field | Type | What it is |
|---|---|---|
service | string | The sylphx.toml service whose dockerfile and context apply; unset reads the fields below or lets the zero-config frontend detect the stack. |
dockerfile | string | A Dockerfile path relative to the input root; unset lets the zero-config frontend detect the stack. |
target | string | The Dockerfile stage to build. |
build_args | map<string, string> | Build arguments. Secret values bind through [build.secrets], never here. |
CommandTarget
| Field | Type | What it is |
|---|---|---|
argv | string[] | The program and its arguments. Use ["bash", "-lc", "…"] for a shell. Required. |
artifacts | string[] | Globs, relative to the input root, of files kept after the command ends, whatever its exit code (test reports, coverage). |
Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
BuildOutput
| Field | Type | What it is |
|---|---|---|
image | string | The image reference: registry.sylphx.net/<path>@sha256:<hex>. Output only. |
image_digest | string | The image manifest digest. Output only. |
sbom_digest | string | The SBOM Artifact digest. Output only. |
provenance_digest | string | The signed SLSA provenance Artifact digest. Output only. |
artifact | string | The artifact in Sylphx Artifacts that holds the three. Output only. |
exit_code | int32 | The command's own exit code. Output only. |
artifacts | BuildArtifact[] | The files the command's artifacts globs matched, by digest. Output only. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/builds" \
-H "Authorization: Bearer $SYLPHX_API_KEY"