providers

Modify Provider

Update an existing custom provider.

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Path parameters

provider_idstringRequiredformat: "^provider-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"=45 characters

The ID of the provider in the format ‘provider-<uuid4>’

Request

This endpoint expects an object.
api_keystringRequired
API key or secret key used for requests to the provider.
access_keystring or nullOptional
Access key used for requests to the provider.
regionstring or nullOptional
Region used for requests to the provider.
base_urlstring or nullOptional
Base URL used for requests to the provider.
api_versionstring or nullOptional
API version used for requests to the provider.

Response

Successful Response
namestring
The name of the provider
provider_typeenum
The type of the provider
provider_categoryenum

The category of the provider (base or byok)

Allowed values:
idstring or null
The id of the provider, lazily created by the database manager.
api_keystring or null
API key or secret key used for requests to the provider.
base_urlstring or null
Base URL for the provider.
access_keystring or null
Access key used for requests to the provider.
regionstring or null
Region used for requests to the provider.
api_versionstring or null
API version used for requests to the provider.
updated_atstring or nullformat: "date-time"
The last update timestamp of the provider.
api_key_encstring or null
Encrypted API key as Secret object
access_key_encstring or null
Encrypted access key as Secret object

Errors