BookStack icon

BookStack

Consume BookStack API

Overview

This node integrates with the BookStack API, allowing users to manage BookStack resources such as shelves, books, pages, chapters, users, roles, attachments, and tags. Specifically for the Shelf - Delete operation, it enables deleting a shelf resource by its ID.

Common scenarios where this node is beneficial include automating content management workflows in BookStack, such as programmatically removing outdated or unused shelves without manual intervention. For example, an organization might use this node to clean up shelves that are no longer relevant after a project ends.

Properties

Name Meaning
Tool Description Choose how to determine the resource and operation:
- Set Automatically
- Set Manually
Request Description (Shown only if "Set Automatically" is selected) Describe your request in natural language; the system will try to infer the resource and operation automatically. Example: "Delete shelf with ID 123".
ID The unique identifier of the shelf resource to delete. This is required for the Delete operation.

Output

The node outputs JSON data representing the response from the BookStack API after attempting to delete the shelf. Typically, this will be an empty object or confirmation message indicating successful deletion.

  • json: Contains the API response confirming the deletion.
  • No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the BookStack API.
  • The node expects the base URL of the BookStack instance and authentication tokens to be configured in the credentials.
  • HTTP requests are made to the BookStack REST API endpoints.

Troubleshooting

  • Missing or invalid ID: If the ID property is not provided or incorrect, the API will return an error. Ensure the correct shelf ID is specified.
  • Authentication errors: If the API key or token is missing or invalid, the node will fail to authenticate. Verify credentials are correctly set up.
  • Resource not found: Attempting to delete a non-existent shelf ID will result in an error. Confirm the shelf exists before deletion.
  • Permission issues: The API user must have sufficient permissions to delete shelves. Lack of permissions will cause authorization errors.
  • Automatic detection failures: When using automatic mode with a natural language description, ambiguous or unclear descriptions may lead to incorrect operation/resource detection. Use manual mode if needed.

Links and References

Discussion