Skip to main content

ExternalApiConnectorCreate

Creates a bare connector with no OpenAPI spec and no endpoints. Import a spec afterwards via POST /external-apis/{connectorId}/endpoints/import. The slug is derived from name and de-duplicated within the organization.

namestringrequired

Possible values: non-empty and <= 255 characters

descriptionstring

Possible values: <= 2000 characters

baseUrlstring<uri>required
authTypeConnectorAuthType (string)required

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

authCredentialstring

Required when authType is api-key, api-key-query, or bearer-token. Not used for oauth2-client-credentials (token sourced from oauthTokenUrl) or none. Write-only, never returned in responses.

authParamNamestring

Possible values: <= 255 characters

Default value: Authorization
authSchemestring

Possible values: <= 50 characters

oauthTokenUrlstring<uri>

Required when authType is oauth2-client-credentials.

oauthClientIdstring

Required when authType is oauth2-client-credentials.

Possible values: <= 255 characters

oauthClientSecretstring

Required when authType is oauth2-client-credentials. Write-only, never returned in responses.

oauthScopestring

Possible values: <= 255 characters

oauthClientAuthMethodOAuthClientAuthMethod (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
defaultTimeoutinteger

Milliseconds. Defaults to the platform's configured connector timeout when omitted.

Possible values: >= 1000 and <= 120000

ExternalApiConnectorCreate
{
  "name": "string",
  "description": "string",
  "baseUrl": "string",
  "authType": "api-key",
  "authCredential": "string",
  "authParamName": "Authorization",
  "authScheme": "string",
  "oauthTokenUrl": "string",
  "oauthClientId": "string",
  "oauthClientSecret": "string",
  "oauthScope": "string",
  "oauthClientAuthMethod": "basic",
  "defaultHeaders": {},
  "defaultTimeout": 0
}