Skip to main content
POST
Connect Connector

Authorizations

x-api-key
string
header
required

API Key for authentication

Path Parameters

connector_id
string
required

Body

application/json

Request model for creating a new connection to a connector.

A connection binds a connector to your organization with specific authentication credentials and settings. The security and headers fields are write-only — they are accepted on create but never returned in any response for security reasons.

For OAuth2 connectors, the API may return an oauth2_required response with a URL to complete browser-based authentication.

name
string
required

Human-readable name for this connection. Must be descriptive enough to distinguish from other connections to the same connector (e.g., 'Production Slack', 'Staging Jira').

version
string | null

Pin this connection to a specific connector version. Leave None to use the connector's latest version.

security
Security · object | null

Authentication credentials for this connection (WRITE-ONLY — never returned in responses). Structure depends on the connector's auth type: API key auth: {'authMethod': 'apiKey', 'apiKey': '...', 'headerName': 'X-API-Key'}. OAuth2: {'authMethod': 'oauth2', 'oauth2Token': {...}}.

general_params
GeneralParam · object[] | null

Pre-filled parameters applied to all operations through this connection. Useful for setting common path/query/header params like workspace IDs or API versions.

headers
Headers · object | null

Custom HTTP headers to include in all API calls through this connection (WRITE-ONLY — never returned in responses). Used for additional authentication or routing headers.

target_system_servers
Target System Servers · object[] | null

Override the connector's default server URLs. Each entry should have a 'url' field and optional 'description'. Use this to point the connection at a different environment (e.g., staging vs production).

access_scope
string | null
default:personal

Who can use this connection. 'personal' (default) restricts to the creating user. 'organizational' makes it available to all org members.

is_service_account
boolean | null
default:false

Set to True if this connection uses shared service account credentials rather than personal user credentials. Only meaningful with 'organizational' access scope.

Response

Successful Response