Skip to main content
GET
Get Container

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
container_id
string
required

Response

Lifecycle and status details of the requested container.

appId
string

ID of the app the container belongs to.

buildId
string

ID of the build the container was created from.

containerIp
string

IP address of the container.

containerRestartExitCode
integer

Exit code from the container's last restart. Omitted when not available.

containerRestartMessage
string

Message associated with the container's last restart. Omitted when not available.

containerRestartReason
string

Reason for the container's last restart. Omitted when not available.

containerRestartSignal
integer

Signal that caused the container's last restart. Omitted when not available.

containerTerminationExitCode
integer

Exit code from the container's termination. Omitted when not available.

containerTerminationMessage
string

Message associated with the container's termination. Omitted when not available.

containerTerminationReason
string

Reason the container terminated. Omitted when not terminated.

containerTerminationSignal
integer

Signal that terminated the container. Omitted when not available.

endedAt
string

Timestamp when the container ended, in RFC3339 format. Empty while running.

hardwareProvider
string

Cloud provider the container is running on.

hostIp
string

IP address of the host running the container.

isTerminating
boolean

Whether the container is currently shutting down.

podDeletionTimestamp
string

Timestamp when the container was marked for deletion. Omitted when not set.

projectId
string

ID of the project the container belongs to.

region
string

Region the container is running in.

requestedAt
string

Timestamp when the container was requested, in RFC3339 format.

restartCount
integer

Number of times the container has restarted.

startedAt
string

Timestamp when the container started, in RFC3339 format.

state
string

Current state of the container.