Sign in
providers

Update Stored Provider

Changed on

Update a stored provider. Omitted fields are left as-is; an explicit null clears them.

api_key follows the same rule: omit it to keep the stored key, send a new one to rotate, or send null to clear it. The row is locked FOR UPDATE so the expected_updated_at check and the write it guards are atomic.

patch/api/v1/provider-credentials/{instance}

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

instancestring required

Request body

api_basestring nullable
api_keystring nullable

New API key. Omit to keep the existing one. Never returned.

client_argsobject nullable
expected_updated_atstring nullable

Optimistic concurrency: if set, the update 412s unless it matches the stored updated_at.

provider_typestring nullable

Response

Successful Response

api_basestring nullable
client_argsobject
created_atstring nullable
decryptableboolean
instancestring required
last4string nullable
provider_typestring nullable
updated_atstring nullable

Changes

  • fbee488d4d9fRevision changes
    • info

      added the optional property to the response with the status

  • e27406481fffRevision changes
    • info

      api operation id update_stored_provider_api_v1_provider_credentials__instance__patch removed and replaced with providers-update_stored_provider