Skip to content

Fill gaps from assistant conversations: API key lifecycle docs #334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fill gaps from assistant conversations: API key lifecycle docs #334

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c953673
docs: document API key expiration, rotation, and deletion on REST API…
mintlify[bot] Aug 31, 2026
d989a34
docs: use active voice in API key management section
mintlify[bot] Aug 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions endpoints/inference-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ description: Call your Cerebrium apps over the REST API with POST requests and J

All functions on Cerebrium are accessible via POST requests, unless marked private by prefixing the function name with an underscore (e.g. `_private_function()`). Authenticate using the JWT token from the **API Keys** section of the dashboard. Endpoints require this token only when `cerebrium.toml` sets [`disable_auth = false`](/toml-reference/toml-reference). Authentication is disabled by default.

## Managing API keys

Create and manage keys in the **API Keys** section of the dashboard, or with the [Create API Key](/api-reference/api-keys/create-api-key) endpoint. Cerebrium returns the secret value once, at creation time.

- **Expiration**: Set an optional expiration date (`YYYY-MM-DD`) when creating a key. A key without an expiration date never expires.
- **Rotation**: Cerebrium does not rotate keys automatically. To rotate a key, create a new key, update your clients to use it, then delete the old key.
- **Deletion**: Deleting a key is permanent. Requests using the deleted key start failing within a few seconds, and you cannot recover the key. Only project owners can delete keys. To remove a key that belongs to a service account, delete the service account.

## Request format

The POST request follows the structure below, where `{function}` is the name of the function to invoke. This example calls `predict()` from `main.py`.
Expand Down
Loading