Skip to main content
PATCH
/
connectors
/
{idOrKey}
Update connector partially
curl --request PATCH \
  --url https://api.getmembrane.com/connectors/{idOrKey} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "name": "<string>",
  "logoUri": "<string>",
  "externalAppId": "<string>",
  "externalAppUuid": "<string>",
  "categories": [
    "<string>"
  ],
  "type": "integration-app-token",
  "customCredentialsSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceUdm": "<string>",
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "inputSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceUdm": "<string>",
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "parametersSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceUdm": "<string>",
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "getCredentialsFromConnectionParameters": {
    "type": "mapping"
  },
  "refreshCredentials": {
    "type": "mapping"
  },
  "makeApiClient": {
    "type": "mapping"
  },
  "getOAuthConfig": {
    "type": "mapping"
  },
  "getTokenData": {
    "type": "mapping"
  },
  "getCredentialsFromAccessTokenResponse": {
    "type": "mapping"
  },
  "getCredentialsFromRefreshTokenResponse": {
    "type": "mapping"
  },
  "test": {
    "type": "mapping"
  },
  "disconnect": {
    "type": "mapping"
  },
  "proxyKey": "<string>",
  "options": {}
}
'
{
  "id": "<string>",
  "key": "<string>",
  "uuid": "<string>",
  "name": "<string>",
  "logoUri": "<string>",
  "baseUri": "<string>",
  "version": "<string>",
  "externalAppId": "<string>",
  "categories": [
    "<string>"
  ],
  "isPublic": true,
  "popularity": 123,
  "tenantId": "<string>",
  "archivedAt": "<string>",
  "revision": "<string>",
  "dataCollectionsCount": 123,
  "operationsCount": 123,
  "eventsCount": 123,
  "udms": [
    "<string>"
  ],
  "hasTest": true,
  "hasAuthTest": true,
  "hasOperations": true,
  "hasData": true,
  "isReadOnly": true,
  "credentialsSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceUdm": "<string>",
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "type": "integration-app-token",
  "customCredentialsSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceUdm": "<string>",
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "inputSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceUdm": "<string>",
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "parametersSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceUdm": "<string>",
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "getCredentialsFromConnectionParameters": {
    "type": "mapping"
  },
  "refreshCredentials": {
    "type": "mapping"
  },
  "makeApiClient": {
    "type": "mapping"
  },
  "getOAuthConfig": {
    "type": "mapping"
  },
  "getTokenData": {
    "type": "mapping"
  },
  "getCredentialsFromAccessTokenResponse": {
    "type": "mapping"
  },
  "getCredentialsFromRefreshTokenResponse": {
    "type": "mapping"
  },
  "test": {
    "type": "mapping"
  },
  "disconnect": {
    "type": "mapping"
  },
  "proxyKey": "<string>",
  "options": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
idOrKey
string
required

Body

application/json
​
key
string
​
name
string
​
logoUri
string
​
externalAppId
string
​
externalAppUuid
string
​
categories
string[]
​
type
enum<string>
Available options:
integration-app-token,
membrane-token,
oauth2,
oauth1,
client-credentials,
proxy
​
customCredentialsSchema
object
​
inputSchema
object
​
parametersSchema
object
​
getCredentialsFromConnectionParameters
object
​
refreshCredentials
object
​
makeApiClient
object
​
getOAuthConfig
object
​
getTokenData
object
​
getCredentialsFromAccessTokenResponse
object
​
getCredentialsFromRefreshTokenResponse
object
​
test
object
​
disconnect
object
​
proxyKey
string
​
options
object

Response

200 - application/json
​
id
string
required
​
key
string
required
​
uuid
string
required
​
name
string
required
​
logoUri
string
required
​
baseUri
string
required
​
version
string
required
​
externalAppId
string
​
categories
string[]
​
isPublic
boolean
​
popularity
number
​
tenantId
string
​
archivedAt
string

When set, the connector is archived (soft-deleted).

​
revision
string
​
dataCollectionsCount
number
​
operationsCount
number
​
eventsCount
number
​
udms
string[]
​
hasTest
boolean
​
hasAuthTest
boolean
​
hasOperations
boolean
​
hasData
boolean
​
isReadOnly
boolean
​
credentialsSchema
object
​
type
enum<string>
Available options:
integration-app-token,
membrane-token,
oauth2,
oauth1,
client-credentials,
proxy
​
customCredentialsSchema
object
​
inputSchema
object
​
parametersSchema
object
​
getCredentialsFromConnectionParameters
object
​
refreshCredentials
object
​
makeApiClient
object
​
getOAuthConfig
object
​
getTokenData
object
​
getCredentialsFromAccessTokenResponse
object
​
getCredentialsFromRefreshTokenResponse
object
​
test
object
​
disconnect
object
​
proxyKey
string
​
options
object