Skip to main content
GET
Get TOML Config

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
owner
string
required
repo
string
required

Query Parameters

branch
string

Branch to read the configuration from (either branch or commit is required)

commit
string

Commit SHA to read the configuration from; takes precedence over branch (either branch or commit is required)

path
string

Directory path within the repository containing cerebrium.toml (defaults to the repository root)

Response

The parsed cerebrium.toml configuration from the repository.

config
object

Parsed cerebrium.toml configuration; omitted if no cerebrium.toml was found at the given location.