v3

latestOpenAPI 3.0.02026-07-31278263961.8 KB
Connectors

Update connector partially

patch/connectors/{idOrKey}

Path parameters

idOrKeystring required

Request body

keystring
namestring
logoUristring
externalAppIdstring
externalAppUuidstring
categoriesstring[]
type'integration-app-token' | 'membrane-token' | 'oauth2' | 'oauth1' | 'client-credentials' | 'proxy'

Authentication protocol used by the connector.

proxyKeystring

For type: "proxy" — identifies which proxy configuration the workspace should use.

optionsobject

Map of auth option key to auth configuration, for connectors that support multiple auth methods. Mutually exclusive with the top-level auth fields: use either the top-level fields (single-auth) OR options (multi-auth), not both.

Response

idstring required
keystring required
uuidstring required
externalAppIdstring
namestring required
logoUristring required
appUristring

Site URL of the linked external app, denormalized onto public connector listings.

categoriesstring[]
isPublicboolean
popularitynumber
tenantIdstring
archivedAtstring

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

baseUristring
revisionstring
dataCollectionsCountnumber
operationsCountnumber
eventsCountnumber
udmsstring[]
hasTestboolean
hasAuthTestboolean
hasOperationsboolean
hasDataboolean
isReadOnlyboolean
versionstring required
type'integration-app-token' | 'membrane-token' | 'oauth2' | 'oauth1' | 'client-credentials' | 'proxy'

Authentication protocol used by the connector.

proxyKeystring

For type: "proxy" — identifies which proxy configuration the workspace should use.

optionsobject