Update API Key
PATCH
/api/api-keys/{id}
Update an API key's name, status, permissions, or modules.
Authorizations
ApiKeyAuth
API key for authentication. Get your API key from the dashboard.
TypeAPI Key (header: X-Api-Key)
Parameters
Path Parameters
id*
Typestring
RequiredRequest Body
application/json
JSON
{
"name": "string",
"enabled": true,
"permissions": [
"string"
],
"modules": [
"string"
]
}
Responses
API key updated
application/json
JSON
{
"data": {
"id": "string",
"name": "string",
"prefix": "string",
"start": "string",
"organizationId": "string",
"enabled": true,
"permissions": [
"string"
],
"modules": [
"string"
],
"expiresAt": "string",
"createdAt": "string",
"updatedAt": "string",
"rateLimitEnabled": true,
"rateLimitTimeWindow": 0,
"rateLimitMax": 0,
"requestCount": 0,
"lastRequest": "string"
}
}