Build API

Build API to start, monitor, cancel, and read logs for container image builds in Scalix Cloud, with every build scoped to your project.

REST API endpoints for Build. 6 operations.

List builds

plaintext

GET /v1/build

Returns the builds for the caller's project.

Auth: Bearer API key

Responses

Status	Description
`200`	Build list
`401`	Missing or invalid API key
`500`	Internal error

operationId: listBuilds

Start a build

plaintext

POST /v1/build

Starts a container image build and returns the build record. For a private repository, either install the Scalix GitHub App for the project (builds then authenticate themselves) or pass auth_token.

Auth: Bearer API key

Request body

application/json (required) — schema BuildCreateRequest.

Responses

Status	Description
`200`	Build started
`401`	Missing or invalid API key
`500`	Internal error

operationId: createBuild

Get a build

plaintext

GET /v1/build/{id}

Returns a single build by id.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Build id

Responses

Status	Description
`200`	Build details
`401`	Missing or invalid API key
`500`	Internal error

operationId: getBuild

Cancel a build

plaintext

POST /v1/build/{id}/cancel

Cancels an in-progress build.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Build id

Responses

Status	Description
`200`	Build cancelled
`401`	Missing or invalid API key
`500`	Internal error

operationId: cancelBuild

Get build logs

plaintext

GET /v1/build/{id}/logs

Returns log output for a build.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Build id

Responses

Status	Description
`200`	Build logs
`401`	Missing or invalid API key
`500`	Internal error

operationId: getBuildLogs

Upload source and build

plaintext

POST /v1/build/upload

Builds from an uploaded source tree instead of a URL, so the source never has to be reachable from the internet. The request body IS the gzipped tarball (Content-Type: application/gzip); metadata goes in the query string. Multipart is not accepted.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`image_tag`	query	`string`	No	Tag for the resulting image. Auto-generated if omitted.
`dockerfile_path`	query	`string`	No	Path to the Dockerfile within the uploaded tree. Auto-detected if omitted.
`build_args`	query	`string`	No	Build-time ARGs as a url-encoded JSON object, e.g. {"VITE_API_URL":"https://api.example.com"}
`timeout_seconds`	query	`integer (int32)`	No	Build timeout in seconds. Default 600, maximum 3600.

Request body

application/gzip (required) — schema string.

Responses

Status	Description
`201`	Build started
`400`	Body is empty, not a gzipped tarball, too large, or build_args is malformed
`401`	Missing or invalid API key
`500`	Internal error

operationId: uploadBuild