BookStack icon

BookStack

Consume BookStack API

Actions40

Overview

This node integrates with the BookStack API to manage tags and other resources such as books, pages, chapters, shelves, users, roles, and attachments. Specifically, for the Tag - Delete operation, it allows users to delete a tag resource by specifying its ID.

Common scenarios where this node is beneficial include automating content management workflows in BookStack, such as cleaning up unused or obsolete tags programmatically, or integrating tag deletion into larger automation pipelines that maintain documentation or knowledge bases.

Practical example: Automatically removing tags that are no longer relevant after a content update or migration, ensuring the tagging system remains clean and organized without manual intervention.

Properties

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

Output

The output contains a JSON object representing the response from the BookStack API after attempting to delete the specified tag. Typically, for a successful delete operation, the API returns confirmation or an empty object indicating success.

  • json: The JSON response from the API.
  • pairedItem: Metadata linking the output to the input item index.

No binary data is output by this node.

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 /tags/{id} to perform deletions.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent tag ID will result in an error from the API.
    • Incorrect or missing API credentials will cause authentication failures.
    • Network connectivity issues to the BookStack server can prevent the request from completing.

  • Error messages:

    • Errors returned from the API typically include HTTP status codes like 404 (Not Found) if the tag ID does not exist, or 401/403 for authentication/authorization failures.
    • If the node throws an error about missing parameters, ensure the "ID" field is filled when performing delete operations.

  • Resolutions:

    • Verify the tag ID exists before attempting deletion.
    • Confirm API credentials and base URL are correctly set.
    • Check network access to the BookStack server.
    • Use the "Continue On Fail" option in the node settings to handle errors gracefully in workflows.

Links and References

Discussion