PIpipeshub-ai
Connector Instances

Delete connector instance

Changed on

Start the deletion of a connector instance and all associated data.<br><br> <b>Asynchronous:</b><br> The request is answered with <code>202</code> as soon as the instance is marked <code>DELETING</code>; its sync is stopped and its records, vectors and configuration are removed in the background.<br><br> <b>Permissions:</b><br>

<ul> <li>The creator can delete their own instance</li> <li>An org admin can delete any instance, including another user's personal one (which the admin cannot read)</li> <li>Anyone else gets <code>404</code></li> </ul> <b>In use:</b><br> Refused with <code>409</code> while an agent uses the instance as a knowledge source.
delete/connectors/{connectorId}

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/connectors/{connectorId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: connector:delete

Path parameters

connectorIdstring required

Connector instance ID (_key of the instance)

Response

Deletion accepted. The connector is marked DELETING and removed in the background, so a GET shortly afterwards answers 404.

successboolean required
messagestring required
connectorIdstring required

ID of the connector being deleted

status'DELETING' required

Example response

{
  "message": "Connector deletion initiated"
}

Changes

  • dbb5e203b445Revision changes
    • breaking

      added the pattern ^[A-Za-z0-9_-]{1,64}$ to the path request parameter connectorId

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • a44792e4f0e6Revision changes
    • info

      endpoint added