FruxonDocs
ApiApikeys

Update an API key

Updates the metadata or permissions of an existing API key. The key secret cannot be changed - generate a new key if needed.

PATCH
/v1/tenants/{tenant}/apiKeys/{apiKey}

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

apiKey*string

The API key identifier

tenant*string

The tenant identifier

Request Body

The fields to update

isActive?boolean|null

When supplied, flips the key's active state. Transitioning active → inactive also stamps Fruxon.Model.ApiKeys.ApiKey.RevokedAt so the dashboard can render "revoked 3 days ago" instead of just "inactive."

[key: string]?never

Response Body

curl -X PATCH "https://api.fruxon.com/v1/tenants/string/apiKeys/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "name": "string",
  "userId": "string",
  "createdBy": "string",
  "apiKeyHash": "string",
  "keyPrefix": "string",
  "type": "USER",
  "isActive": false,
  "expiresAt": 0,
  "scopes": [
    "string"
  ],
  "revokedAt": 0,
  "lastUsedAt": 0,
  "createdAt": 0,
  "id": "00000000-0000-0000-0000-000000000000",
  "modifiedAt": 0,
  "tenantId": "00000000-0000-0000-0000-000000000000"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}