Skip to main content
POST
/
api2
/
v1
/
connectors
Create connector
curl --request POST \
  --url https://cloud.memsource.com/web/api2/v1/connectors \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "<string>",
  "commitMessage": "<string>",
  "defaultRemoteFolder": "<string>",
  "encodedDefaultRemoteFolder": "<string>",
  "sourceUrl": "<string>"
}
'
{
  "created": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "linkedAccount": "<string>",
  "localToken": "<string>",
  "name": "<string>",
  "status": "<string>",
  "type": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developers.phrase.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

​
connectionTest
boolean

Run a connection test before creating; automatically true for MAGENTO and TYPO3

Body

application/json
​
name
string
required

Name of the connector

Maximum string length: 255
​
type
string
required

Connector type

​
commitMessage
string
​
defaultRemoteFolder
string
​
encodedDefaultRemoteFolder
string
​
sourceUrl
string

Response

Created

​
created
string<date-time>

Date and time the connector was created

​
id
string

Internal numeric identifier, encoded as a string

​
linkedAccount
string

Name of the account linked to this connector on the remote service; null if unavailable

​
localToken
string

Backend token identifying this connector; required by connector backend calls

​
name
string

Connector display name

​
status
string

Connection status reported by the backend; null if the backend did not return a status

​
type
string

Connector type identifier (e.g. FTP, GIT, GITHUB)