Skip to main content
GET
List Runs

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

status
string

Filter runs by status.

runId
string

Retrieve a specific run by its ID.

containerId
string

Filter runs by the container that executed them.

asyncOnly
boolean

Set to true to only return asynchronous runs.

websocketOnly
boolean

Set to true to only return websocket runs.

minQueueTimeMs
integer

Only return runs queued for at least this many milliseconds.

maxQueueTimeMs
integer

Only return runs queued for at most this many milliseconds.

minContainerQueueTimeMs
integer

Only return runs that waited at least this many milliseconds for a container.

minResponseTimeMs
integer

Only return runs with a response time of at least this many milliseconds.

maxResponseTimeMs
integer

Only return runs with a response time of at most this many milliseconds.

afterDate
string

Only return runs created after this timestamp, in RFC3339 format.

beforeDate
string

Only return runs created before this timestamp, in RFC3339 format.

region
string

Filter runs by region.

nextToken
string

Pagination token from a previous response.

includeEphemeral
boolean

Include runs from ephemeral apps. Set to true to include them.

Response

A page of runs matching the filters.

hitMaxLoops
boolean

Whether the query stopped early before scanning all matching runs.

items
array

Runs ordered by creation time. Each item includes id, modelId, projectId, status, statusCode (integer), async (boolean), websocket (boolean), createdAt, updatedAt, completedAt, containerId, containerStartedAt, functionName, method, region, timing fields in milliseconds (queueTimeMs, runtimeMs, responseTimeMs, activatorQueueTimeMs, containerQueueTimeMs, totalQueueTimeMs, executionTimeMs, totalResponseTimeMs), and for ephemeral runs the run configuration (ephemeral, command, hardware, cpu, memory, gpuCount, createdByUserId).

nextToken
string

Pagination token to pass as nextToken to retrieve the next page. Empty when there are no more results.