Authentication
Datasource APIs
Embeds
Embedding APIs (Legacy)
Metric APIs
Copy
curl --request POST \
--url https://api.usedatabrain.com/api/v2/data-app/rotate-api \
--header 'Authorization: Bearer 550e8400-e29b-41d4-a716-446655440000' \
--header 'Content-Type: application/json' \
--data '{
"expireAt": 0
}'
Copy
{
"key": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}
Copy
curl --request POST \
--url https://api.usedatabrain.com/api/v2/data-app/rotate-api \
--header 'Authorization: Bearer 550e8400-e29b-41d4-a716-446655440000' \
--header 'Content-Type: application/json' \
--data '{
"expireAt": 0
}'
Copy
{
"key": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}
API Tokens
Rotate API Key
Rotate your Data App API key to enhance security and manage key lifecycle effectively.
Copy
curl --request POST \
--url https://api.usedatabrain.com/api/v2/data-app/rotate-api \
--header 'Authorization: Bearer 550e8400-e29b-41d4-a716-446655440000' \
--header 'Content-Type: application/json' \
--data '{
"expireAt": 0
}'
Copy
{
"key": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}
POST
https://api.usedatabrain.com
/
api
/
v2
/
data-app
/
rotate-api
Copy
curl --request POST \
--url https://api.usedatabrain.com/api/v2/data-app/rotate-api \
--header 'Authorization: Bearer 550e8400-e29b-41d4-a716-446655440000' \
--header 'Content-Type: application/json' \
--data '{
"expireAt": 0
}'
Copy
{
"key": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}
Rotate your data app API key to maintain security best practices by periodically refreshing credentials. This endpoint expires the current API key and generates a new one, ensuring seamless transition while maintaining security.
The API key used in the
Authorization header is the key being rotated. You only need to provide expireAt in the request body — no key field required.Authentication
This endpoint requires the data app API key you want to rotate in theAuthorization header. The key used for authentication is the key that will be expired and replaced with a new one.
To access your data app API key:
- Go to your Databrain dashboard and open the Data Apps section.
- Select the data app whose API key you want to rotate.
- Find the API Key under the data app settings.
Headers
Bearer token for API authentication. Use the data app API key you want to rotate.
Copy
Authorization: Bearer 550e8400-e29b-41d4-a716-446655440000
Must be set to
application/json for all requests.Copy
Content-Type: application/json
Request Body
Duration in seconds until the current API key expires. This allows for a grace period to update your applications before the old key stops working. Accepts a number or a numeric string.
Show Common expiration durations
Show Common expiration durations
0- Expire immediately (instant rotation)300- 5 minutes3600- 1 hour86400- 24 hours604800- 7 days
3600) to allow time for updating your applications without service interruption.Response
The newly generated API key (UUID format). Use this key for all future API requests.
Examples
HTTP Status Code Summary
| Status Code | Description |
|---|---|
200 | OK - Key rotated successfully |
400 | Bad Request - Invalid request parameters or invalid key state |
401 | Unauthorized - API key not found in DB or already expired |
500 | Internal Server Error - Server error occurred |
Possible Errors
| Error Code | HTTP Status | Description |
|---|---|---|
INVALID_REQUEST_BODY | 400 | Missing or invalid expireAt parameter |
AUTHENTICATION_ERROR | 400 / 401 | API key missing or not a valid UUID (400); or not found / already expired in DB (401) |
INVALID_DATA_APP_API_KEY | 400 | Token is a service token (no dataAppId), key not found, belongs to a different org, or the key already has an expiry date set |
INTERNAL_SERVER_ERROR | 500 | Server error |
Related Resources
⌘I