Skip to main content
PUT
replace-connector

Authorizations

Authorization
string
header
required

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

Path Parameters

idOrKey
string
required

Connector id, uuid, or key to replace

Body

application/json
key
string
name
string
logoUri
string
externalAppId
string
externalAppUuid
string
appUuid
string

[INTERNAL] Deprecated: resolved to externalAppId

categories
string[]
parameters
object

Connector-level parameter values.

authOptions
any

[INTERNAL] Agent-only auth option array normalized into top-level fields or the options record.

type
enum<string>

Authentication protocol used by the connector.

Available options:
integration-app-token,
membrane-token,
oauth2,
oauth1,
client-credentials,
proxy,
oauth-client
customCredentialsSchema
object

JSON Schema for workspace-level credential overrides.

inputSchema
object

JSON Schema for end-user connection input.

parametersSchema
object
getCredentialsFromConnectionParameters
object

Function that derives auth credentials from connection parameters.

refreshCredentials
object

Function that refreshes expired credentials.

makeApiClient
object

Function that configures the authenticated HTTP client used by connector requests and actions.

getOAuthConfig
object

OAuth2 function returning { authorizeUri, tokenUri, scopes, noRefreshToken? }.

getTokenData
object

OAuth2 function that extracts metadata from the raw token response.

getCredentialsFromAccessTokenResponse
object

OAuth2 function that transforms the token endpoint response into the final credentials object.

getCredentialsFromRefreshTokenResponse
object

OAuth2 function that transforms the refresh response into refreshed credentials.

test
object

Function that verifies the connection with a lightweight authenticated API call.

disconnect
object

Function that revokes provider credentials when the connection is removed.

proxyKey
string

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

oauthClientKey
string

For type: "oauth-client" — identifies the organization OAuth client used for this option.

ui
object

[INTERNAL] Deprecated: Use inputSchema instead

options
object

Auth configurations keyed by option name. Mutually exclusive with top-level auth fields.

Response

200 - application/json

Replace an existing connector by id or key.

id
string
key
string
name
string
isReadOnly
boolean
{key}
any