keys

Update a key name or IP allowlist

P3-013 policy: the allowlist is a list of IPv4/IPv6 addresses or IPv4 CIDR blocks; empty clears it.

patch/v1/keys/{id}

Request

  • Base URL: https://api.hyperresearch.ai
  • URL: https://api.hyperresearch.ai/v1/keys/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie hr_session

Path parameters

idstring required

Request body

namestring
ip_allowliststring[]

Response

Updated

idstring required
namestring nullable required
prefix'hr_live_' | 'hr_test_' | 'hr_chat_' required
maskedstring required
scopesstring[] required
last_used_atstring nullable required
expires_atstring nullable required
revoked_atstring nullable required
created_atstring required
ip_allowliststring[] required
rotate_bystring nullable required
rotation_dueboolean required

Example response

{
  "id": "key_01J9ZQ7V6H0000000000000000",
  "masked": "hr_live_7Qa1bC3dE5f9…"
}

Changes

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