Knowledge Base

Delete knowledge base

Changed on

Permanently delete a knowledge base and all its contents.

Required permission:

User must have OWNER role on the knowledge base.

What gets deleted:

  • All folders within the KB
  • All records and their indexed content
  • All permission grants
  • Associated storage files

Warning: This action is irreversible. Consider exporting data before deletion.

Request: only the kbId path parameter is read; any query string or body is ignored.

delete/knowledgeBase/{kbId}

Request

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

Path parameters

kbIdstring required
Example:8a095180-2989-4018-b448-70eb75fba1c7

Knowledge base ID (non-empty string)

Response

Knowledge base deleted successfully

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "Knowledge base deleted successfully"
}

Changes

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status