Skip to content

UpdateExternalProviderRequest

Type: object

Properties

Property Type Required Description
displayName string No
description string No
endpointUrl string No

FQDN of the external provider with no scheme or path (e.g. api.openai.com)

Constraints: minimum length 1; maximum length 253; pattern ^[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)+$

authMechanism string No

Allowed values: apikey, sigv4, oauth2

credentialSecretRef string No
provider string No

Provider identifier (spec.provider)

Constraints: minimum length 1; maximum length 63; pattern ^\S(?:.*\S)?$

config map of string No

Optional provider-specific configuration key-value pairs (spec.config)

Example

{
  "displayName": "string",
  "description": "string",
  "endpointUrl": "string",
  "authMechanism": "apikey",
  "credentialSecretRef": "string",
  "provider": "string",
  "config": {
    "key": "string"
  }
}