Skip to navigation

Update API key

Updates name or description. Provide at least one field; unknown fields are rejected with 400. The token, M2M client, and expiry cannot be changed; rotate with regenerate.

Requires every scope: api-keys:write.

Authentication

AuthorizationBearer

JWT returned by POST /api/auth/token-exchange. Amazon, authorization invitations, and developer credentials require API-key-derived tokens.

Path parameters

idintegerRequired1-2147483647
Numeric API key ID.

Request

This endpoint expects an object.
namestringOptional>=1 character
descriptionstring or nullOptional

Response

Success
apiKeyobject
API key metadata. The token is never included.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error