Sign in
keys

Update Key

Changed on

Update an API key in the caller's organization.

Requires master key authentication.

patch/api/v1/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 required

Request body

allowed_modelsstring[] nullable
capture_agent_telemetryboolean nullable
end_user_budget_idstring nullable
end_user_budget_idsstring[] nullable
exclude_from_budgetboolean nullable
expires_atstring date-time nullable
is_activeboolean nullable
is_service_keyboolean nullable
key_namestring nullable
metadataobject nullable
reject_user_mismatchboolean nullable

Response

Successful Response

allowed_modelsstring[] nullable required
capture_agent_telemetryboolean nullable required
created_atstring required
end_user_budget_idstring nullable required
end_user_budget_idsstring[] required
exclude_from_budgetboolean required
expires_atstring nullable required
idstring required
is_activeboolean required
is_service_keyboolean required
key_namestring nullable required
key_prefixstring nullable required
key_suffixstring nullable required
last_used_atstring nullable required
metadataobject required
reject_user_mismatchboolean nullable required
user_idstring nullable required
workspace_idstring uuid required

Changes

  • fbee488d4d9fRevision changes
    • info

      added the optional property to the response with the status

  • 5125607f1676Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status