provider-keys

Unset Org Provider Key Default

Changed on

Stop a key being the organization's default for its provider. Organization owners and admins only.

Idempotent: a key that is not the default is returned unchanged. With no default, a request that names no instance gets the provider's earliest-created key the workspace has not disabled.

delete/api/v1/organizations/me/provider-keys/{key_id}/default

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

Response

Successful Response

api_basestring nullable
archived_atstring date-time nullable
client_argsobject nullable
created_atstring date-time required
idstring uuid required
is_org_defaultboolean required
last4string nullable
namestring required
offered_countinteger required

How many models the organization offers on this key. Zero means the key has never been refreshed, so it is unnarrowed and reaches whatever its provider serves.

organization_idstring uuid required
providerstring required
serving_countinteger required

How many of the offered models have their serving switch on. A key offering models and serving none refuses every request through it until one is switched on.

updated_atstring date-time nullable
usableboolean required

False when the stored credential cannot be decrypted on this deployment, so the key supplies nothing at dispatch and the catalog withholds its provider. A row this deployment cannot read is still listed, because deleting or replacing it is what fixes it.

Changes