Skip to main content
GET
Get Build

Authorizations

Authorization
string
header
required

Service Account Token authentication. To authenticate API requests:

  1. Create a Service Account Token:

    • Go to the Cerebrium Dashboard and open the API Keys page
    • Click Create Service Account, name it (e.g., "GitHub Actions CI/CD"), choose an expiry date, and click Create
    • Copy the token generated for the desired service account
  2. Use the Token: Include the service account token in the Authorization header of API requests: Authorization: Bearer <your-service-account-token>

  3. Best Practices:

    • Create separate service accounts for different environments (dev, staging, prod)
    • Store tokens securely as secrets in consuming applications or workflows
    • Set appropriate expiry dates and rotate tokens regularly
    • Never commit tokens to source control

For CI/CD integration examples, see the CI/CD documentation.

Path Parameters

project_id
string
required
app_id
string
required
build_id
string
required

Response

Full configuration and status details of the requested build.

buildTimeMs
string

Time taken to build, in milliseconds, as a string value.

cerebriumVersion
string

Version of the client used at deployment time.

checkpointing
boolean

Whether checkpointing is enabled for the build.

cliVersion
string

Version of the client that created the build.

computeTier
string

Compute tier of the build, interruptible or protected. Omitted when not set.

containerRuntime
string

Container runtime version. Omitted when not set.

cooldownPeriod
integer

Cooldown period in seconds before an idle replica scales down.

cpu
number

Number of CPU cores allocated.

createdAt
string

Timestamp when the build was created.

createdByUserEmail
string

Email address of the user who created the build.

createdByUserIp
string

IP address the build was created from.

deadlineSeconds
integer

Maximum run duration in seconds, if set.

deploymentInitializationTimeout
integer

Maximum time in seconds to wait for the deployment to initialize.

disableAuth
boolean

Whether authentication is disabled on the app endpoint.

dockerBaseImageUrl
string

Base Docker image used for the build.

dockerfilePath
string

Path to the Dockerfile used, if any.

entrypoint
array

Command used to start a custom runtime app, as a list of strings.

evaluationIntervalSeconds
integer

Interval in seconds between autoscaling evaluations.

finalState
object

Configuration after the update, for update builds. Omitted when not set.

gpuCount
integer

Number of GPUs allocated.

hardware
string

Compute type the build targets.

hardwareFallbacks
array

Fallback compute types, in priority order. Omitted when not set.

hardwareProvider
string

Cloud provider the build targets.

hasDockerAuth
boolean

Whether private registry credentials were provided.

healthcheckEndpoint
string

HTTP endpoint used to check that the app is healthy.

id
string

Unique identifier of the build.

imageSizeBytes
integer

Size of the built image in bytes.

initError
string

Error message from deployment initialization, if any. Omitted when not set.

initTimeMs
string

Time taken to initialize the deployment, in milliseconds, as a string value.

loadBalancingAlgorithm
string

Load balancing algorithm used by the app.

maxReplicaCount
integer

Maximum number of replicas.

memory
number

Memory allocation in GB.

minReplicaCount
integer

Minimum number of replicas.

modelId
string

ID of the app the build belongs to.

name
string

Name of the app.

originalState
object

Configuration before the update, for update builds. Omitted when not set.

port
integer

Port the app listens on.

projectId
string

ID of the project the build belongs to.

pythonVersion
string

Python version used for the build.

readycheckEndpoint
string

HTTP endpoint used to check that the app is ready to receive traffic.

region
string

Region the build targets.

replicaConcurrency
integer

Maximum concurrent requests per replica.

responseGracePeriodSeconds
integer

Grace period in seconds for in-flight requests when a replica stops.

revisionName
string

Name of the revision created by this build.

rollOutDurationSeconds
integer

Duration in seconds over which the new version is rolled out.

runtime
string

App runtime, cortex or custom.

runtimeVersion
string

Version of the app runtime.

scalingBuffer
integer

Number of extra replicas kept available beyond current demand.

scalingMetric
string

Metric used for autoscaling.

scalingTarget
integer

Target value for the scaling metric.

status
string

Current status of the build.

type
string

Type of the build.

updateInput
object

Configuration changes requested, for update builds. Omitted when not set.

updatedAt
string

Timestamp when the build was last updated.

useUv
boolean

Whether uv is used for Python package installation. Omitted when not set.

zipSizeBytes
integer

Size of the uploaded source archive in bytes.