Search Containers
Search containers by ID or status with pagination.
Authorizations
Service Account Token authentication. To authenticate API requests:
-
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
-
Use the Token: Include the service account token in the Authorization header of API requests:
Authorization: Bearer <your-service-account-token> -
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.
Query Parameters
Search term to filter containers by container ID
Filter containers by status/state (case-insensitive, e.g., running, RUNNING, Running all work)
Number of containers to return (max 100, default 25)
Page number for pagination (default 1)
Response
A paginated list of containers matching the search criteria, most recent first.
Identifier of the app the container belongs to.
Identifier of the build the container is running.
Unique identifier of the container instance.
IP address assigned to the container.
Total number of times the container has restarted.
How long the container ran, in milliseconds.
Time the container started (ISO 8601). Omitted if unavailable.
Lifecycle state of the container (e.g. RUNNING, SUCCEEDED, FAILED, PENDING).
Exit code the container terminated with. Omitted if the container has not terminated.
Time the container terminated (ISO 8601). Omitted if the container has not terminated.
Cloud provider hosting the container.
IP address of the host machine running the container.
Identifier of the project the app belongs to.
Region where the container is running.
Time of the most recent status report for this container (ISO 8601).