> ## 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 App

> Retrieve details for a specific app in a project.



## OpenAPI

````yaml https://s3.eu-west-1.amazonaws.com/www.cerebrium.ai/openapi_spec.json get /v2/projects/{project_id}/apps/{app_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}:
    get:
      tags:
        - Apps
      summary: Get App
      description: Retrieve details for a specific app in a project.
      operationId: getApp
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
        - name: app_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Full configuration and status details of the requested app.
          content:
            application/json:
              schema:
                properties:
                  baseImage:
                    description: Base Docker image the app is built from.
                    type: string
                  cerebriumVersion:
                    description: Version of the client used to deploy the app.
                    type: string
                  computeTier:
                    description: Compute tier of the app, interruptible or protected.
                    type: string
                  cooldownPeriodSeconds:
                    description: >-
                      Cooldown period in seconds before an idle replica scales
                      down, as a string value.
                    type: string
                  costPerSecondCents:
                    description: >-
                      Estimated cost per second in US cents while a replica is
                      running, as a string value.
                    type: string
                  cpu:
                    description: Number of CPU cores allocated, as a string value.
                    type: string
                  createdAt:
                    description: Timestamp when the app was created.
                    type: string
                  deploymentInitializationTimeout:
                    description: >-
                      Maximum time in seconds to wait for a deployment to
                      initialize, as a string value.
                    type: string
                  disableAuth:
                    description: Whether authentication is disabled on the app endpoint.
                    type: boolean
                  entrypoint:
                    description: >-
                      Command used to start a custom runtime app, as a list of
                      strings.
                    type: array
                  errorMessage:
                    description: Error message from the most recent failure, if any.
                    type: string
                  evaluationIntervalSeconds:
                    description: >-
                      Interval in seconds between autoscaling evaluations, as a
                      string value.
                    type: string
                  gpuCount:
                    description: Number of GPUs allocated, as a string value.
                    type: string
                  hardware:
                    description: Compute type the app runs on.
                    type: string
                  hardwareProvider:
                    description: Cloud provider the app is deployed on.
                    type: string
                  healthcheckEndpoint:
                    description: HTTP endpoint used to check that the app is healthy.
                    type: string
                  id:
                    description: Unique identifier of the app.
                    type: string
                  internalEndpoint:
                    description: Base URL for invoking the app.
                    type: string
                  lastBuildStatus:
                    description: Status of the most recent build.
                    type: string
                  latestBuildId:
                    description: ID of the most recent build.
                    type: string
                  latestCreatedBuildId:
                    description: ID of the most recently created build.
                    type: string
                  latestReadyBuildId:
                    description: ID of the most recent build that reached the ready state.
                    type: string
                  loadBalancingAlgorithm:
                    description: Load balancing algorithm used by the app.
                    type: string
                  maxReplicaCount:
                    description: Maximum number of replicas, as a string value.
                    type: string
                  memory:
                    description: Memory allocation in GB, as a string value.
                    type: string
                  minReplicaCount:
                    description: Minimum number of replicas, as a string value.
                    type: string
                  name:
                    description: Name of the app.
                    type: string
                  port:
                    description: Port the app listens on.
                    type: integer
                  projectId:
                    description: ID of the project the app belongs to.
                    type: string
                  pythonVersion:
                    description: Python version the app uses.
                    type: string
                  readycheckEndpoint:
                    description: >-
                      HTTP endpoint used to check that the app is ready to
                      receive traffic.
                    type: string
                  region:
                    description: Region the app is deployed in.
                    type: string
                  replicaConcurrency:
                    description: >-
                      Maximum concurrent requests per replica, as a string
                      value.
                    type: string
                  responseGracePeriodSeconds:
                    description: >-
                      Grace period in seconds for in-flight requests when a
                      replica stops, as a string value.
                    type: string
                  rollOutDurationSeconds:
                    description: >-
                      Duration in seconds over which a new version is rolled
                      out, as a string value.
                    type: string
                  runtime:
                    description: App runtime, cortex or custom.
                    type: string
                  scalingBuffer:
                    description: >-
                      Number of extra replicas kept available beyond current
                      demand, as a string value.
                    type: string
                  scalingMetric:
                    description: Metric used for autoscaling.
                    type: string
                  scalingTarget:
                    description: Target value for the scaling metric, as a string value.
                    type: string
                  status:
                    description: Current status of the app.
                    type: string
                  updatedAt:
                    description: Timestamp when the app was last updated.
                    type: string
                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).

````