Skip to content

ExternalProviderDetails

ExternalProvider fields not present on the ExternalModel providerRef

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

Name of the Secret holding provider credentials (spec.auth.secretRef.name)
provider string No

Provider identifier (spec.provider)
config map of string No
phase string No
statusMessage string No

Human-readable status message from the Ready condition in status.conditions
reason string No

Reason from the Ready condition in status.conditions

Example: Reconciled

Example

{
  "displayName": "string",
  "description": "string",
  "endpointUrl": "string",
  "authMechanism": "apikey",
  "credentialSecretRef": "string",
  "provider": "string",
  "config": {
    "key": "string"
  },
  "phase": "string",
  "statusMessage": "string",
  "reason": "Reconciled"
}