Skip to main content

ExternalApiConnectorUpdate

All fields optional; only provided fields are updated. Cannot set openApiSpec here (use the import endpoint). Setting status to suspended is rejected (operator-only) and returns 401 Unauthorized even though the value is otherwise a valid enum member. Changing authType, or rewriting any oauth* credential field, invalidates the connector's cached OAuth2 access token.

namestring

Possible values: non-empty and <= 255 characters

descriptionstring | nullnullable

Possible values: <= 2000 characters

baseUrlstring<uri>
authTypeConnectorAuthType (string)

Possible values: [api-key, api-key-query, bearer-token, oauth2-client-credentials, none]

authCredentialstring | nullnullable

Write-only. Omit to leave the stored credential untouched.

authParamNamestring

Possible values: <= 255 characters

authSchemestring | nullnullable

Possible values: <= 50 characters

oauthTokenUrlstring,null<uri>nullable
oauthClientIdstring | nullnullable

Possible values: <= 255 characters

oauthClientSecretstring | nullnullable

Write-only. Omit to leave the stored secret untouched.

oauthScopestring | nullnullable

Possible values: <= 255 characters

oauthClientAuthMethod object
oneOf
OAuthClientAuthMethod (string)

How the connector authenticates to its OAuth2 token endpoint: basic sends credentials in an Authorization: Basic header, body sends client_id/client_secret in the form body.

Possible values: [basic, body]

defaultHeaders object
property name*string
statusConnectorStatus (string)

Possible values: [active, paused, suspended]

isPublicboolean
defaultTimeoutinteger

Possible values: >= 1000 and <= 120000

ExternalApiConnectorUpdate
{
  "name": "string",
  "description": "string",
  "baseUrl": "string",
  "authType": "api-key",
  "authCredential": "string",
  "authParamName": "string",
  "authScheme": "string",
  "oauthTokenUrl": "string",
  "oauthClientId": "string",
  "oauthClientSecret": "string",
  "oauthScope": "string",
  "oauthClientAuthMethod": "basic",
  "defaultHeaders": {},
  "status": "active",
  "isPublic": true,
  "defaultTimeout": 0
}