hosted-providers

Update Hosted Provider

Changed on

Rotate the key, repoint the base, or turn a provider off.

A provider defined in configuration answers 409: it is changed there.

patch/api/v1/hosted-providers/{provider}

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

providerstring required

Request body

api_basestring nullable
api_keystring nullable
client_argsobject nullable
enabledboolean nullable
restricted_to_organization_idstring uuid nullable

Example request

{
  "enabled": false
}

Response

Successful Response

api_basestring nullable
api_key_last4string nullable
client_argsobject nullable
created_atstring date-time nullable
decryptableboolean
enabledboolean required
has_api_keyboolean
idstring uuid nullable
namestring required
providerstring required
restricted_to_organization_idstring uuid nullable
shadows_configboolean
source'database' | 'config'
updated_atstring date-time nullable

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      response property created_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property id list-of-types was widened by adding types null to media type application/json of response 200

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status