BookStack icon

BookStack

Consume BookStack API

Actions31

Overview

This node integrates with the BookStack API to manage content resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the Page - Delete operation, it allows users to delete a page resource by specifying its unique ID. This is useful in scenarios where outdated or incorrect pages need to be removed from the BookStack documentation system.

Practical examples:

  • Automatically removing obsolete pages during a content cleanup workflow.
  • Deleting test or draft pages created during content staging.
  • Integrating with external systems to synchronize deletions of pages.

Properties

Name Meaning
ID The unique identifier of the page resource to delete. This is required to specify which page should be removed.

Output

The node outputs JSON data representing the response from the BookStack API after attempting to delete the specified page. Typically, a successful deletion returns an empty body or confirmation status. No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the BookStack API.
  • The base URL of the BookStack instance must be configured in the credentials.
  • The node uses HTTP DELETE requests to the endpoint /pages/{id} where {id} is the page ID.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent page ID will result in an error from the API indicating the resource was not found.
    • Missing or incorrect API authentication token will cause authorization errors.
    • Network connectivity issues to the BookStack server can prevent the request from completing.
  • Error messages and resolutions:

    • 404 Not Found: The specified page ID does not exist. Verify the ID is correct.
    • 401 Unauthorized or 403 Forbidden: Authentication failed. Check that the API token and base URL are correctly set in credentials.
    • Network errors/timeouts: Ensure the BookStack server is reachable and the URL is correct.

Links and References

Discussion