Create connector
Creates a connector of the specified type.
A connection test is run automatically for MAGENTO and TYPO3 connector types, or whenever connectionTest=true is passed.
For OAuth-based connectors (e.g. GitHub, GitLab, Google Drive, OneDrive), complete the three-step OAuth flow first:
POST /connectorAuthData → user authorizes → POST /connectorAuthCode. Then include the resulting code in the request.
For credential-based connectors (FTP, SFTP, GIT, Amazon S3, etc.) no OAuth flow is required.
Requires ADMIN or PROJECT_MANAGER role with the Connector setup access right.
Authorizations
Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.
Query Parameters
Run a connection test before creating; automatically true for MAGENTO and TYPO3
Body
Response
Created
Date and time the connector was created
Internal numeric identifier, encoded as a string
Name of the account linked to this connector on the remote service; null if unavailable. For connector types without a live connection test (e.g. PHRASE, GIT), this may be null while the connector is in the initial PENDING synchronization state and becomes populated once synchronization completes.
Backend token identifying this connector; required by connector backend calls
Connector display name
Connection status reported by the backend; null if the backend did not return a status. Fetched live from the connector backend on every call. A live remote connectivity test is only run for MAGENTO and TYPO3 connector types (see PATCH connector docs); for all other types this reflects the backend's stored credential/sync state rather than a live health check. For PHRASE (Strings job sync) and GIT connectors, PENDING is a valid, expected state meaning an initial synchronization is still in progress - typically right after connector creation - and is not itself an error; the status transitions to OK once synchronization completes.
Connector type identifier (e.g. FTP, GIT, GITHUB)