Skip to main content
POST
Create API Key

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

Query Parameters

name
string

Name of the API key (max 50 characters). Defaults to 'API Key'.

description
string

Description of the API key (max 255 characters).

expiresAt
string

Expiration date in YYYY-MM-DD format. Must be in the future. If omitted, the key never expires.

Response

The created API key, including its secret value.

apiKey
string

The API key value.

createdAt
string

Creation timestamp in RFC 3339 format.

description
string

Description of the API key.

expiresAt
string

Expiration timestamp in RFC 3339 format, or "never" if the key does not expire.

id
string

Unique identifier of the API key.

name
string

Name of the API key.

projectId
string

ID of the project the API key belongs to.

source
string

Origin of the API key.

status
string

Status of the API key.

updatedAt
string

Last update timestamp in RFC 3339 format.