Key Management

Update API key

Update a key name, revoke it, or change its expiry. Version 1 member identity and workspace are immutable; revoke the existing key and authorize a new key to change the acting member. Add context=personal to manage only the JWT owner's personal key, including after joining an organization or losing paid eligibility. Expiry is set with expires_in_days (a duration from now; null removes it) — expires_at is not settable. An expiry sent alongside a revoke (is_active: false) is dropped and the revoke is honoured; an expiry cannot be combined with reactivating a key.

patch/keys/{keyId}

Request

  • Base URL: https://app.arkova.ai/api/v1
  • URL: https://app.arkova.ai/api/v1/keys/{keyId}
  • Auth: HTTP bearer

Path parameters

keyIdstring uuid required

Query parameters

context'personal'

Manage only the JWT owner's personal key.

Headers

X-Org-Idstring uuid

Exact selected organization. Requires current membership there; never falls back to the profile organization. Cannot be combined with context=personal.

Request body

namestring
scopesstring[]
expires_in_daysinteger nullable

Set the expiry this many days from now, or null to remove the expiry entirely. REPLACES any existing expiry — it does not add to it — so a value earlier than the current expiry is refused with 409 api_key_expiry_would_shorten unless allow_shorten is true.

assigned_user_idstring uuid nullable

UAT-21: reassign the key to another current organization member, or null to unassign it. 400 assignee_not_org_member otherwise.

allow_shortenboolean

Acknowledge that expires_in_days moves the expiry EARLIER (or gives an unexpiring key an expiry). Required for such a change; ignored otherwise.

Response

Key updated

Changes

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