v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB
Connections

Delete connection

Archive a connection (move to trash). Archived connections can be restored from the trash in the connection settings UI.

A connection that is already archived returns 410.

delete/api/v1/connections/{id}

Path parameters

idstring uuid required

Connection ID

Example:550e8400-e29b-41d4-a716-446655440000

Connection ID

Response

Connection moved to trash

messagestring required

Status message describing the result

successboolean required

True when the connection was archived

Example response

{
  "message": "Connection moved to trash.",
  "success": true
}