Reference

Builds

A Build runs one command or builds one image over one input.

Checked 2026-09-28

A Build runs one command or builds one image over one input. The input is a commit (read through the Broker at that exact commit) or a tree uploaded to the org's store; the output is the command's exit code and named artifacts, or an image with an SBOM and signed provenance. A Build is immutable once created; it ends with its output or a typed failure.

Service Sylphx Build · Resource type build.sylphx.com/Build · Name pattern orgs/{org}/projects/{project}/builds/{build} · Shape spec_status

#Fields

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.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

Method	Call	What it does
GET	get	Gets a build.
GET	list	Lists builds in a project.
POST	create	Creates a build: one command or one image over a commit or a tree. The Operation is done when the build reaches a final state. run and image are the short forms.
POST	cancel	Cancels a queued or running Build; its lease is released and nothing is published.
POST	run	Runs one command over an uploaded tree and settles with its exit code, like the local command. A caller that gets a failure before the command started (BUILD_FAILURE_SETUP_FAILED, NO_CAPACITY) may build locally.
POST	build_image	Builds an image, with an SBOM and signed provenance, from a commit or an uploaded tree.
GET	read_logs	Reads a page of a build's log lines, oldest first. With wait, an empty page on a running build waits up to that long for new lines, so a client follows the log by passing each next_page_token back.

#get

Gets a build.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/builds/build · scope build:read · effect read · Request, response and examples

#list

Lists builds in a project.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/builds · scope build:read · effect read · paginated · Request, response and examples

#create

Creates a build: one command or one image over a commit or a tree. The Operation is done when the build reaches a final state. run and image are the short forms.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/builds · scope build:run · effect write · long-running · Request, response and examples

#cancel

Cancels a queued or running Build; its lease is released and nothing is published.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/builds/build:cancel · scope build:run · effect destructive · validate_only · long-running · Request, response and examples

#run

Runs one command over an uploaded tree and settles with its exit code, like the local command. A caller that gets a failure before the command started (BUILD_FAILURE_SETUP_FAILED, NO_CAPACITY) may build locally.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/builds:run · scope build:run · effect write · validate_only · long-running · Request, response and examples

#build_image

Builds an image, with an SBOM and signed provenance, from a commit or an uploaded tree.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/builds:buildImage · scope build:run · effect write · validate_only · long-running · Request, response and examples

#read_logs

Reads a page of a build's log lines, oldest first. With wait, an empty page on a running build waits up to that long for new lines, so a client follows the log by passing each next_page_token back.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/builds/build:readLogs · scope build:read · effect read · Request, response and examples