BookStack icon

BookStack

Manage BookStack resources

Overview

This node integrates with the BookStack platform to manage its resources programmatically. Specifically, for the Shelf - Delete operation, it allows users to delete a shelf by specifying its unique identifier. This is useful in scenarios where you want to automate content management workflows, such as cleaning up unused or obsolete shelves in your BookStack instance.

Practical examples include:

  • Automatically removing shelves that are no longer relevant based on external triggers.
  • Integrating with other systems to maintain synchronized content structures by deleting shelves when corresponding data is removed elsewhere.

Properties

Name Meaning
Shelf ID The unique identifier of the shelf to delete (e.g., "789"). This is required to specify which shelf should be deleted.

Output

The output JSON contains the response from the BookStack API after attempting to delete the specified shelf. Typically, this will be an empty object or confirmation message indicating successful deletion. No binary data is produced by this operation.

Example output JSON might look like:

{}

or a minimal confirmation structure depending on the API response.

Dependencies

  • Requires an active connection to a BookStack instance via an API key credential.
  • The node depends on the BookStack REST API being accessible and the provided API key having sufficient permissions to delete shelves.
  • No additional environment variables are needed beyond the configured API authentication.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Shelf ID will result in an error from the BookStack API.
    • Insufficient permissions for the API key can cause authorization errors.
    • Network connectivity problems may prevent the node from reaching the BookStack server.
  • Error messages and resolutions:

    • "Shelf not found": Verify the Shelf ID is correct and exists in the BookStack instance.
    • "Unauthorized" or "Forbidden": Check that the API key has delete permissions for shelves.
    • "Network Error" or timeouts: Ensure the BookStack server URL is reachable and correct in the credentials configuration.

Links and References

Discussion