API Keys

Update name / scopes of an own API key

Updates mutable fields of one of your own API keys: name and/or scopes. Only the fields you send are changed; sending an empty body returns 400. The secret and environment are immutable — rotate by creating a new key and revoking the old one.

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

Request

  • Base URL: https://api.hub-equity.com
  • URL: https://api.hub-equity.com/api/v1/api-keys/{key_id}
  • Auth: HTTP bearer

Path parameters

key_idstring uuid required

Request body

namestring nullable
scopesstring[] nullable
allowed_cidrsstring[] nullable

Replace the allowed IP ranges (Enterprise plan); send [] to allow every IP again.

plan_override'free' | 'pro' | 'enterprise' nullable

Response

Successful Response

successboolean required

Changes

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