Skip to main content

ExternalApiConnector

A registered external REST API. Secret fields (authCredential, oauthClientSecret, the cached oauthAccessToken) are write-only and never serialized in responses.

idinteger
namestring
slugstring
descriptionstring | nullnullable
baseUrlstring<uri>
authTypeConnectorAuthType (string)

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

authParamNamestring

Header or query param name the auth credential is sent under, e.g. Authorization or X-API-Key.

authSchemestring | nullnullable

Scheme prefix for the auth header value, e.g. Bearer.

oauthTokenUrlstring,null<uri>nullable
oauthClientIdstring | nullnullable
oauthScopestring | nullnullable
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]

oauthTokenExpiresAtstring,null<date-time>nullable
defaultHeaders object

Header map merged into every proxied/test request to this connector.

property name*string
openApiSpecobject | nullnullable

The raw OpenAPI document last imported via the import endpoint, or null before any import.

specVersionstring | nullnullable

Possible values: [2.0, 3.0, 3.1, null]

statusConnectorStatus (string)

Possible values: [active, paused, suspended]

isPublicboolean

Whether this connector (and its public endpoints) appear in the cross-organization marketplace catalog (GET /external-apis/public).

defaultTimeoutinteger

Default upstream request timeout in milliseconds, used when an endpoint does not set its own timeout.

organizationIdinteger
createdAtstring<date-time>
updatedAtstring<date-time>
deletedAtstring,null<date-time>nullable
ExternalApiConnector
{
  "id": 0,
  "name": "string",
  "slug": "string",
  "description": "string",
  "baseUrl": "string",
  "authType": "api-key",
  "authParamName": "string",
  "authScheme": "string",
  "oauthTokenUrl": "string",
  "oauthClientId": "string",
  "oauthScope": "string",
  "oauthClientAuthMethod": "basic",
  "oauthTokenExpiresAt": "2024-07-29T15:51:28.071Z",
  "defaultHeaders": {},
  "openApiSpec": "Unknown Type: object,null",
  "specVersion": "2.0",
  "status": "active",
  "isPublic": true,
  "defaultTimeout": 0,
  "organizationId": 0,
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "deletedAt": "2024-07-29T15:51:28.071Z"
}