API Keys

Update Api Key

Update an API key. Requires a Pro plan or higher.

Gated because a PATCH can widen scopes (read -> write/admin) and flip is_active back on — the same capability grant create charges for. A free caller who wants a key switched off can still DELETE it, which stays ungated, so this gate cannot strand anyone with a key they cannot revoke.

patch/api/v1/api-keys/{key_id}

Request

  • Base URL: https://app.aimrank.io (the document declares no server; this is the origin it was published from)
  • URL: https://app.aimrank.io/api/v1/api-keys/{key_id}
  • Auth: none declared

Path parameters

key_idstring required

Request body

namestring nullable
scopesstring[] nullable
is_activeboolean nullable
allowed_ipsstring[] nullable
allowed_rankingsstring[] nullable
rate_limitinteger nullable

Response

Successful Response

idstring required
namestring required
key_prefixstring required
scopesstring[] required
rate_limitinteger required
is_activeboolean required
expires_atstring date-time nullable required
last_used_atstring date-time nullable required
usage_countinteger required
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.