BookStack icon

BookStack

Consume BookStack API

Actions31

Overview

This node integrates with the BookStack API to manage various resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the Tag resource with the Delete operation, it allows users to delete a tag by specifying its ID. This is useful in scenarios where you want to programmatically remove tags that are no longer needed or were created by mistake.

Practical example: If you have an automated workflow that cleans up metadata or categorization tags in your BookStack instance, this node can be used to delete specific tags based on their IDs.

Properties

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

Output

The node outputs the response from the BookStack API after attempting to delete the specified tag. The output JSON typically contains confirmation of deletion or error details if the operation failed.

Since this is a delete operation, no binary data is expected in the output.

Dependencies

  • Requires connection to a BookStack instance via its API.
  • Needs an API token credential with appropriate permissions to delete tags.
  • The base URL and authentication tokens must be configured in the node credentials.
  • The node uses HTTP DELETE requests to the endpoint /tags/{id} where {id} is the tag ID.

Troubleshooting

  • Common issues:

    • Invalid or missing tag ID will cause the API to return an error.
    • Insufficient permissions or invalid API token will result in authorization errors.
    • Incorrect base URL or network issues may cause connection failures.
  • Error messages:

    • 404 Not Found: The tag ID does not exist. Verify the ID is correct.
    • 401 Unauthorized: Authentication failed. Check API token credentials.
    • 400 Bad Request: The request parameters are invalid. Ensure the ID is provided and correctly formatted.

To resolve these, verify the tag ID, ensure the API token has delete permissions, and confirm the BookStack API URL is correct.

Links and References

Discussion