Skip to main content
GET
List Containers

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

Response

A list of the app's current containers with their lifecycle and readiness state.

appId
string

Identifier of the app the container belongs to.

appState
string

Readiness of the container to serve traffic (Ready, NotReady, or Terminating).

containerId
string

Unique identifier of the container instance.

containerRestartCount
integer

Total number of times the container has restarted.

containerRunningTimeMs
integer

How long the container has been running, in milliseconds.

containerStartTimestamp
string

Time the container started (ISO 8601). Omitted if the container has not started.

containerState
string

Lifecycle state of the container (Running, Succeeded, Failed, or Pending).

containerTerminationTimestamp
string

Time the container stopped serving (ISO 8601). Omitted if the container has not terminated.

hostIp
string

IP address of the host machine running the container.

podName
string

Instance name of the container; matches containerId.

projectId
string

Identifier of the project the app belongs to.

revision
string

Deployment revision of the app this container is serving. Omitted if unavailable.

timestamp
string

Time at which this status snapshot was taken (ISO 8601).