PIpipeshub-ai
Knowledge Base

Update folder

Changed on

Rename a folder, at the root or nested.

Required permission: WRITER or higher. A READER gets 403; a caller with no role on the knowledge base gets 404 (Knowledge base not found).

Naming rules: the same as for creating a folder. Whitespace around the name is removed first; HTML is refused with 400 before authentication and a printf-style format specifier with 400 by the gateway controller. A name already used by another folder in the same parent is refused with 409, ignoring case; renaming a folder to its own name, or to the name of a file, is allowed.

Request: kbId and folderId are only checked to be non-empty (an id that is not a UUID is looked up and answered 404). Only folderName is read; other body fields and any query parameter are ignored.

put/knowledgeBase/{kbId}/folder/{folderId}

Request

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

Path parameters

kbIdstring required
folderIdstring required

Request body

folderNamestring required

New name of the folder. Whitespace around it is removed first, so a name made only of whitespace is refused as empty. It cannot contain / or \, which folder paths use as separators.

Response

Folder updated successfully

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "Folder updated successfully"
}

Changes

  • dbb5e203b445Revision changes
    • breaking

      added the pattern ^(?![\s\S]*?(?:(?<!\w)%(?:\d{1,10}\$)?[#0\-+ ]{0,10}(?:\d{1,10})?(?:\.\d{1,10})?(?:h{1,2}|l{1,2}|L|z|j|t)?[nsxXp]))[\s\S]*?\S to the request property

    • info

      added the media type application/x-www-form-urlencoded to the request body

  • bb0c59adf026Revision changes
    • 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

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status