Patch connector

Partially updates connector credentials. Only fields included in the request body are changed. The connector type cannot be changed; a type mismatch returns 400. A connection test is run for MAGENTO and TYPO3 connector types, or when connectionTest=true is passed. Requires ADMIN or PROJECT_MANAGER role with the Connector setup access right.

PATCH /api2/v1/connectors/{connectorId}

Patch connector

cURL

curl --request PATCH \
  --url https://cloud.memsource.com/web/api2/v1/connectors/{connectorId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "<string>",
  "commitMessage": "<string>",
  "defaultRemoteFolder": "<string>",
  "encodedDefaultRemoteFolder": "<string>",
  "sourceUrl": "<string>"
}
'

200

{
  "created": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "linkedAccount": "<string>",
  "localToken": "<string>",
  "name": "<string>",
  "status": "<string>",
  "type": "<string>"
}

Authorizations

ApiTokenOAuth2

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.

Path Parameters

connectorId · string · required

Internal numeric ID of the connector

Query Parameters

connectionTest · boolean

Run a connection test before saving; 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

200

application/json

OK

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)