GEgetmembrane
Connections

Create a new connection

post/connections

Request

  • Base URL
    https://api.getmembrane.com
  • URL
    https://api.getmembrane.com/connections
  • Auth
    HTTP bearer

Request body

type'connector' | 'mcp'
namestring
metaobject
authOptionKeystring
keystring nullable
integrationIdstring
integrationUuidstring
integrationKeystring
connectorIdstring
connectorUuidstring
connectorKeystring
connectorVersionstring
externalAppIdstring
externalAppUuidstring
credentialsobject
connectorParametersobject
inputobject
intentstring

[Experimental] Intent-based instruction for an agent to configure this element.

Response

idstring required

Internal database ID of the element. Assigned by the API; unique per element.

namestring required
userIdstring required
tenantIdstring
type'connector' | 'mcp'
keystring
isTestboolean
connectedboolean
disconnectedboolean

Use connected instead.

isDefunctboolean
state'BUILDING' | 'CLIENT_ACTION_REQUIRED' | 'CONFIGURATION_ERROR' | 'SETUP_FAILED' | 'READY' | 'DISCONNECTING'
integrationIdstring
connectorIdstring
externalAppIdstring
connectorVersionstring
authOptionKeystring
createdAtstring required
updatedAtstring required
lastActiveAtstring
nextCredentialsRefreshAtstring
nextRetryTimestampstring
retryAttemptsnumber
canTestboolean
canRefreshCredentialsboolean
archivedAtstring
isDeactivatedboolean
metaobject
buildingAgentSessionIdstring

Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.

connectorParametersobject
inputobject

Changes

No recorded changes to this operation across all 2 revisions of this API.