Skip to main content
GET
Search 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

Query Parameters

Search term to filter containers by container ID

status
string

Filter containers by status/state (case-insensitive, e.g., running, RUNNING, Running all work)

limit
integer

Number of containers to return (max 100, default 25)

page
integer

Page number for pagination (default 1)

Response

A paginated list of containers matching the search criteria, most recent first.

appId
string

Identifier of the app the container belongs to.

buildId
string

Identifier of the build the container is running.

containerId
string

Unique identifier of the container instance.

containerIp
string

IP address assigned to the container.

containerRestartCount
integer

Total number of times the container has restarted.

containerRunningTimeMs
integer

How long the container ran, in milliseconds.

containerStartTimestamp
string

Time the container started (ISO 8601). Omitted if unavailable.

containerState
string

Lifecycle state of the container (e.g. RUNNING, SUCCEEDED, FAILED, PENDING).

containerTerminationExitCode
integer

Exit code the container terminated with. Omitted if the container has not terminated.

containerTerminationTimestamp
string

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

hardwareProvider
string

Cloud provider hosting the container.

hostIp
string

IP address of the host machine running the container.

projectId
string

Identifier of the project the app belongs to.

region
string

Region where the container is running.

timestamp
string

Time of the most recent status report for this container (ISO 8601).