On this page
Create a build
Creates a build: one command or one image over a commit or a tree.
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.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/builds - Scope
build:run - Effect
write— a successful call changes state. - Collection builds
- Query
build_id,validate_only - Operation answers with an
Operation; the result isBuild
Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to create in. Required. |
build | Build | The build to create; only spec and caller-writable metadata are read. Required. |
build_id | string | The id segment of the name; the server assigns one when unset. |
validate_only | bool | Validate and return the result without writing anything. |
Build
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/builds/{build}. |
meta | ResourceMeta | Resource metadata. |
spec | BuildSpec | Desired state. Required. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
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. |
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. |
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). |
Response
| Field | Type | What it is |
|---|---|---|
name | string | {parent-of-target}/operations/{operation}. |
target | string | The name of the Resource being changed. |
target_generation | int64 | The generation this Operation waits for. |
verb | OperationVerb | What the Operation does. One of create, update, delete, custom. |
custom_verb | string | The custom method verb when verb is CUSTOM, for example revoke. |
done | bool | Whether the Operation has finished. |
create_time | timestamp | When the Operation started. |
end_time | timestamp | When the Operation finished. |
response | any | The settled Resource (or Empty for a delete). One of the result group. |
error | ProblemDetails | The failure, as the one error body. One of the result group. |
progress | OperationProgress | Progress while not done. |
ProblemDetails
| Field | Type | What it is |
|---|---|---|
type | string | https://sylphx.com/docs/errors/<code in kebab-case>. |
title | string | A short customer-safe summary of the problem class. |
status | int32 | The HTTP status, fixed by grpc_status. |
detail | string | A customer-safe explanation of this occurrence. Never contains SQL, stack traces, internal hostnames, or another tenant's data. |
instance | string | The request id (Sylphx-Request-Id). |
code | string | The stable UPPER_SNAKE code, one of ErrorCode without its prefix. |
grpc_status | string | One of the 16 canonical gRPC status names, for example ABORTED. |
retryable | bool | Whether the same request may be retried. |
effect | ErrorEffect | What the failed call committed. One of none, applied, unknown. |
retry_after_ms | int64 | How long to wait before retrying, when the server knows. |
details | any[] | Typed details such as PreconditionFailure or EntitlementDenial. |
OperationProgress
| Field | Type | What it is |
|---|---|---|
percent | int32 | Percent complete, when the controller can tell. |
message | string | A customer-safe progress message. |
conditions | Condition[] | The target's conditions when this progress was read. |
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. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.RESOURCE_ALREADY_EXISTS— A Resource with this name exists.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.PLAN_LIMIT_REACHED— The plan's limit is reached.SPEND_LIMIT_REACHED— The org's spend limit is reached.
Every error arrives in the body Errors describes.
Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/builds" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"spec":{}}'