web-search-keys

Update Org Web Search Key

Changed on

Rename a web search key or replace its secret. Organization owners and admins only.

patch/api/v1/organizations/me/web-search-keys/{key_id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Path parameters

key_idstring uuid required

Request body

api_keystring nullable
namestring nullable

Response

Successful Response

archived_atstring date-time nullable
created_atstring date-time required
idstring uuid required
is_org_defaultboolean required
last4string nullable
namestring required
organization_idstring uuid required
providerstring required
updated_atstring date-time nullable
usableboolean required

False when this deployment cannot decrypt the stored key, so no search uses it. It is still listed, because replacing or deleting it is what fixes it.

Changes