Sign in
v1
protected
provider-configs

Patch Provider Config

Partially update a provider configuration.

patch/v1/workspaces/{workspace}/provider-configs/{config_id}

Path parameters

config_idstring uuid required
workspacestring required

Slug of the workspace the request acts in

Slug of the workspace the request acts in

Request body

api_keystring nullable

New API key. Replaces the previously stored secret. Send an empty string to clear the key for keyless custom endpoints.

api_key_secret_idstring uuid nullable

Point this configuration at an existing workspace secret instead. Mutually exclusive with api_key.

descriptionstring nullable

New description for the configuration.

endpoint_urlstring nullable

New endpoint URL, or empty string to clear.

is_activeboolean nullable

Activate or deactivate the configuration.

is_publicboolean nullable

Toggle workspace-wide visibility.

namestring nullable

New human-readable label for the configuration.

Response

Successful Response

created_atstring required
created_bystring required
endpoint_urlstring nullable required
idstring required
is_activeboolean required
is_publicboolean required
managed_bystring nullable
model_instance_idsstring[]
namestring required
provider_spec_idstring required
provider_spec_keystring nullable
provider_spec_namestring nullable
requires_api_keyboolean
updated_atstring required
workspace_idstring required

Changes

Changed in 1 of the 45 revisions of this API.1