ScalixScalix Docs

Build API

Container image building

REST API endpoints for Build. 5 operations.

List builds

plaintext
GET /v1/build

Returns the builds for the caller's project.

Auth: Bearer API key

Responses

StatusDescription
200Build list
401Missing or invalid API key
500Internal error

operationId: listBuilds

Start a build

plaintext
POST /v1/build

Starts a container image build and returns the build record.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

StatusDescription
200Build started
401Missing or invalid API key
500Internal error

operationId: createBuild

Get a build

plaintext
GET /v1/build/{id}

Returns a single build by id.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesBuild id

Responses

StatusDescription
200Build details
401Missing or invalid API key
500Internal error

operationId: getBuild

Cancel a build

plaintext
POST /v1/build/{id}/cancel

Cancels an in-progress build.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesBuild id

Responses

StatusDescription
200Build cancelled
401Missing or invalid API key
500Internal error

operationId: cancelBuild

Get build logs

plaintext
GET /v1/build/{id}/logs

Returns log output for a build.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesBuild id

Responses

StatusDescription
200Build logs
401Missing or invalid API key
500Internal error

operationId: getBuildLogs