api-keys

Update Api Key

Update an API key's metadata.

patch/v1/api-keys/{api_key_id}

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

api_key_idstring uuid required

Headers

mentium-workspace-idstring nullable

Request body

namestring nullable
descriptionstring nullable
scopesstring[] nullable
rate_limit_per_minuteinteger nullable
rate_limit_per_dayinteger nullable

Response

Successful Response

idstring uuid required
namestring required
key_prefixstring required
status'ACTIVE' | 'REVOKED' | 'EXPIRED' required
scopesstring[] required
descriptionstring nullable required
rate_limit_per_minuteinteger required
rate_limit_per_dayinteger required
last_used_atstring date-time nullable required
usage_countinteger required
expires_atstring date-time nullable required
revoked_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required
integration_connection_idstring uuid nullable required
created_by_user_idstring uuid required
created_by_namestring nullable
integration_connection_namestring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.