Sign in
Connections

Resource-oriented lifecycle transition: <code>ACTIVE</code> (reactivate), <code>SUSPENDED</code> (suspend), or <code>UNINSTALLED</code> (disconnect).

Resource-oriented lifecycle transition: <code>ACTIVE</code> (reactivate), <code>SUSPENDED</code> (suspend), or <code>UNINSTALLED</code> (disconnect). Disconnecting erases the integration's mirrored data and then, best effort, removes what it installed at the provider; if the erase fails, the connection is left unchanged. <code>PENDING</code> is internal to the OAuth handshake and rejected as a bad request; illegal transitions surface as 409 via the state machine.

patch/workspaces/{workspaceSlug}/connections/{id}/status

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/connections/{id}/status
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

idinteger required

Request body

reasonstring

Optional human-readable reason recorded on the audit trail

state'PENDING' | 'ACTIVE' | 'SUSPENDED' | 'UNINSTALLED' required

Target lifecycle state. Admin-settable: ACTIVE, SUSPENDED, UNINSTALLED.

Response

OK

capabilitiesstring[]
createdAtstring date-time
credentialsUnreadableSincestring date-time
displayNamestring
family'SCM' | 'MESSAGING' | 'DOCUMENTATION'
idinteger
instanceKeystring
kind'GITHUB' | 'GITLAB' | 'SLACK' | 'OUTLINE'
state'PENDING' | 'ACTIVE' | 'SUSPENDED' | 'UNINSTALLED'
stateReasonstring
updatedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.