Template builds

Get a template build: state, timestamps, bounds, provenance, results, failure, log tail and builder availability

Bounded wait: with Prefer: wait=<seconds> (at most 20) and a build that is not settled (settled = failed, canceled, legacy succeeded, or published with registration registered/failed), the response is held until state or registration.state changes or the wait elapses, then carries the fresh build and Preference-Applied: wait=<seconds>. Without Preference-Applied the server did not wait: poll with backoff.

get/v1/organizations/{organization_id}/template-builds/{build_id}

Request

  • Base URL: https://api.shardflux.dev
  • URL: https://api.shardflux.dev/v1/organizations/{organization_id}/template-builds/{build_id}
  • Auth: HTTP bearer

Path parameters

organization_idstring uuid required

UUIDv7, lowercase canonical form.

build_idstring uuid required

UUIDv7, lowercase canonical form.

Headers

preferstring

RFC 7240 preference, e.g. wait=20.

Response

Default Response

idstring uuid required

UUIDv7, lowercase canonical form.

organization_idstring uuid required

UUIDv7, lowercase canonical form.

state'queued' | 'building' | 'testing' | 'publishing' | 'published' | 'succeeded' | 'failed' | 'canceled' required

queued -> building -> testing -> publishing -> published (the cell stored the artifact; the API then registers the version, see registration) | failed | canceled. succeeded = legacy builds.

target_versioninteger nullable required

Version number this build produces in its organization template (assigned at request time; never reused, so versions may have gaps). Null only for legacy builds.

auto_publishboolean required

Publish the registered version at once (true), or leave it unpublished for the owner/admin publish route.

published_atstring date-time nullable required

RFC 3339 UTC timestamp with Z.

cancel_requested_atstring date-time nullable required

RFC 3339 UTC timestamp with Z.

created_atstring date-time required

RFC 3339 UTC timestamp with Z.

updated_atstring date-time required

RFC 3339 UTC timestamp with Z.

started_atstring date-time nullable required

RFC 3339 UTC timestamp with Z.

completed_atstring date-time nullable required

RFC 3339 UTC timestamp with Z.

architecturestring required
denied_hostsstring[] required

Host names the builder’s DNS proxy refused during the build (at most 50). Rebuild with a host in build.network.extra_hosts to allow it.

publishableboolean required
source_kind'recipe' | 'workspace' required

recipe (recipe v1 Dockerfile dialect or recipe v2) or workspace (save-as-template, draft publish).

source_workspace_idstring uuid nullable required

UUIDv7, lowercase canonical form.

source_checkpoint_idstring nullable required

The saved checkpoint (filled when the capture finished and the cell claimed the build).

scrub_resultobject nullable required

sf-scrub.v1 report ({policy, removed_count, removed_bytes, removed_paths (first 1000), emptied, reimposed}); paths only, never contents.

filesobject nullable required

The produced file list ({key, size, sha256, content_sha256, entries, total_file_bytes}).

produced_layer_idstring uuid nullable required

UUIDv7, lowercase canonical form.

squashedboolean nullable required

The base chain already had 4 org layers: this build squashed them into its one layer.

org_bytesinteger nullable required

The produced chain’s org bytes (limited by the plan’s workspace disk limit).

immutable_pathsstring[] required

The immutable paths the produced version declares, in byte order: the recipe’s immutable, else the list of the template’s open version (a save from a workspace: the target template’s open version’s list, else the workspace’s version’s). Empty for none.

Changes

No recorded changes to this operation across all 1 revision of this API.