API Keys
Get API key usage
Get usage statistics for a specific API key including request count, rate limit status, and last used timestamp. Requires organization-level authentication (JWT Bearer token). API keys are not supported for this endpoint.
GET
/api/api-keys/{id}/usageSDK setup
Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.
import { Configuration, APIKeysApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const apikeys = new APIKeysApi(configuration);import { Configuration, APIKeysApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const apikeys = new APIKeysApi(configuration);Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const { data: result } = await apikeys.getApiKeyUsage("7wrwKHBWeiIEpK9p");const { data: result } = await apikeys.getApiKeyUsage("7wrwKHBWeiIEpK9p");Playground
liveTest this endpoint with your own credentials. Your requests will be sent to the live API.
Use the auth endpoints to obtain a JWT.
No Request Yet
Send a request to see the full inspector
Authentication
Requires JWT
Note
Include your JWT in the
Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
Responses
200API key usage statistics
json
{
"usage": {
"requests": 1500,
"lastUsed": "2024-01-15T10:00:00.000Z"
},
"rateLimit": {
"limit": 10000,
"remaining": 8500,
"resetAt": "2024-01-16T00:00:00.000Z"
},
"isActive": true,
"expiresAt": "2025-01-15T10:00:00.000Z"
}{
"usage": {
"requests": 1500,
"lastUsed": "2024-01-15T10:00:00.000Z"
},
"rateLimit": {
"limit": 10000,
"remaining": 8500,
"resetAt": "2024-01-16T00:00:00.000Z"
},
"isActive": true,
"expiresAt": "2025-01-15T10:00:00.000Z"
}