XPxpander
API v1
Tools
Tools Discovery

Connect Connector

Create a connection to a connector. For OAuth2 connectors, returns an oauth2_required response with a connector_page_url to complete browser auth.

post/v1/tools/connectors/{connector_id}/connect

Request

  • Base URL
    https://api.xpander.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header x-api-key

Path parameters

connector_idstring required

Request body

namestring 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').

versionstring nullable

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

securityobject nullable

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': {...}}. A credential slot may carry a reference marker {'$secret_ref': '<vault secret id>'} instead of a literal value; the marker is stored and resolved on read.

headersobject nullable

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_serversobject[] nullable

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_scopestring nullable

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

is_service_accountboolean nullable

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

ownerstring nullable

User id that owns a personal connection. Set for personal scope; omit (None) for organizational connections.

descriptionstring nullable

Free-text description for this connection. Defaults to the connector's own description.

per_userboolean nullable

Per-user OAuth placeholder: the connection holds no credential of its own and each user signs in individually. At most one per connector per organization.

project_idstring nullable

The project the connection belongs to; unset means the Default project.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 4 revisions of this API.