> ## Documentation Index
> Fetch the complete documentation index at: https://cerebrium-mintlify-5834c333.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Build

> Retrieve details for a specific build.



## OpenAPI

````yaml https://s3.eu-west-1.amazonaws.com/www.cerebrium.ai/openapi_spec.json get /v2/projects/{project_id}/apps/{app_id}/builds/{build_id}
openapi: 3.0.0
info:
  title: Cerebrium REST API
  description: >-
    REST API for interacting with Cerebrium. This API is mainly used by the
    Cerebrium CLI client, please run `pip install cerebrium` to install it.
  version: 1.0.0
  license:
    name: Proprietary
    url: https://www.cerebrium.ai/terms-of-service
servers:
  - url: https://rest.cerebrium.ai
security: []
paths:
  /v2/projects/{project_id}/apps/{app_id}/builds/{build_id}:
    get:
      tags:
        - Builds
      summary: Get Build
      description: Retrieve details for a specific build.
      operationId: getBuild
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
        - name: app_id
          in: path
          required: true
          schema:
            type: string
        - name: build_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Full configuration and status details of the requested build.
          content:
            application/json:
              schema:
                properties:
                  buildTimeMs:
                    description: Time taken to build, in milliseconds, as a string value.
                    type: string
                  cerebriumVersion:
                    description: Version of the client used at deployment time.
                    type: string
                  checkpointing:
                    description: Whether checkpointing is enabled for the build.
                    type: boolean
                  cliVersion:
                    description: Version of the client that created the build.
                    type: string
                  computeTier:
                    description: >-
                      Compute tier of the build, interruptible or protected.
                      Omitted when not set.
                    type: string
                  containerRuntime:
                    description: Container runtime version. Omitted when not set.
                    type: string
                  cooldownPeriod:
                    description: >-
                      Cooldown period in seconds before an idle replica scales
                      down.
                    type: integer
                  cpu:
                    description: Number of CPU cores allocated.
                    type: number
                  createdAt:
                    description: Timestamp when the build was created.
                    type: string
                  createdByUserEmail:
                    description: Email address of the user who created the build.
                    type: string
                  createdByUserIp:
                    description: IP address the build was created from.
                    type: string
                  deadlineSeconds:
                    description: Maximum run duration in seconds, if set.
                    type: integer
                  deploymentInitializationTimeout:
                    description: >-
                      Maximum time in seconds to wait for the deployment to
                      initialize.
                    type: integer
                  disableAuth:
                    description: Whether authentication is disabled on the app endpoint.
                    type: boolean
                  dockerBaseImageUrl:
                    description: Base Docker image used for the build.
                    type: string
                  dockerfilePath:
                    description: Path to the Dockerfile used, if any.
                    type: string
                  entrypoint:
                    description: >-
                      Command used to start a custom runtime app, as a list of
                      strings.
                    type: array
                  evaluationIntervalSeconds:
                    description: Interval in seconds between autoscaling evaluations.
                    type: integer
                  finalState:
                    description: >-
                      Configuration after the update, for update builds. Omitted
                      when not set.
                    type: object
                  gpuCount:
                    description: Number of GPUs allocated.
                    type: integer
                  hardware:
                    description: Compute type the build targets.
                    type: string
                  hardwareFallbacks:
                    description: >-
                      Fallback compute types, in priority order. Omitted when
                      not set.
                    type: array
                  hardwareProvider:
                    description: Cloud provider the build targets.
                    type: string
                  hasDockerAuth:
                    description: Whether private registry credentials were provided.
                    type: boolean
                  healthcheckEndpoint:
                    description: HTTP endpoint used to check that the app is healthy.
                    type: string
                  id:
                    description: Unique identifier of the build.
                    type: string
                  imageSizeBytes:
                    description: Size of the built image in bytes.
                    type: integer
                  initError:
                    description: >-
                      Error message from deployment initialization, if any.
                      Omitted when not set.
                    type: string
                  initTimeMs:
                    description: >-
                      Time taken to initialize the deployment, in milliseconds,
                      as a string value.
                    type: string
                  loadBalancingAlgorithm:
                    description: Load balancing algorithm used by the app.
                    type: string
                  maxReplicaCount:
                    description: Maximum number of replicas.
                    type: integer
                  memory:
                    description: Memory allocation in GB.
                    type: number
                  minReplicaCount:
                    description: Minimum number of replicas.
                    type: integer
                  modelId:
                    description: ID of the app the build belongs to.
                    type: string
                  name:
                    description: Name of the app.
                    type: string
                  originalState:
                    description: >-
                      Configuration before the update, for update builds.
                      Omitted when not set.
                    type: object
                  port:
                    description: Port the app listens on.
                    type: integer
                  projectId:
                    description: ID of the project the build belongs to.
                    type: string
                  pythonVersion:
                    description: Python version used for the build.
                    type: string
                  readycheckEndpoint:
                    description: >-
                      HTTP endpoint used to check that the app is ready to
                      receive traffic.
                    type: string
                  region:
                    description: Region the build targets.
                    type: string
                  replicaConcurrency:
                    description: Maximum concurrent requests per replica.
                    type: integer
                  responseGracePeriodSeconds:
                    description: >-
                      Grace period in seconds for in-flight requests when a
                      replica stops.
                    type: integer
                  revisionName:
                    description: Name of the revision created by this build.
                    type: string
                  rollOutDurationSeconds:
                    description: >-
                      Duration in seconds over which the new version is rolled
                      out.
                    type: integer
                  runtime:
                    description: App runtime, cortex or custom.
                    type: string
                  runtimeVersion:
                    description: Version of the app runtime.
                    type: string
                  scalingBuffer:
                    description: >-
                      Number of extra replicas kept available beyond current
                      demand.
                    type: integer
                  scalingMetric:
                    description: Metric used for autoscaling.
                    type: string
                  scalingTarget:
                    description: Target value for the scaling metric.
                    type: integer
                  status:
                    description: Current status of the build.
                    type: string
                  type:
                    description: Type of the build.
                    type: string
                  updateInput:
                    description: >-
                      Configuration changes requested, for update builds.
                      Omitted when not set.
                    type: object
                  updatedAt:
                    description: Timestamp when the build was last updated.
                    type: string
                  useUv:
                    description: >-
                      Whether uv is used for Python package installation.
                      Omitted when not set.
                    type: boolean
                  zipSizeBytes:
                    description: Size of the uploaded source archive in bytes.
                    type: integer
                type: object
        '400':
          description: >-
            Bad request. The request was malformed or contained invalid
            parameters.
          content:
            application/json:
              schema:
                properties:
                  message:
                    description: Human-readable description of the error.
                    type: string
                type: object
        '401':
          description: >-
            Unauthorized. The Authorization header is missing or the token is
            invalid.
          content:
            application/json:
              schema:
                properties:
                  message:
                    description: Human-readable description of the error.
                    type: string
                type: object
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Service Account Token authentication. To authenticate API requests:


        1. **Create a Service Account Token:**
           - Go to the [Cerebrium Dashboard](https://dashboard.cerebrium.ai/) 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](https://docs.cerebrium.ai/cerebrium/deployments/ci-cd).

````