BookStack icon

BookStack

Manage BookStack resources

Overview

This node integrates with the BookStack platform, allowing users to manage various BookStack resources such as books, pages, shelves, chapters, and global settings. Specifically, for the Global resource with the Audit Log operation, it retrieves audit log entries from BookStack.

The Audit Log operation is useful for monitoring and reviewing changes or activities within a BookStack instance. For example, administrators can use this node to fetch recent audit logs to track user actions, system events, or security-related activities.

Practical scenarios include:

  • Fetching the latest 50 audit log entries to review recent changes.
  • Paginating through audit logs by specifying an offset to analyze historical data.
  • Integrating audit log retrieval into automated workflows for compliance reporting or alerting.

Properties

Name Meaning
Limit Maximum number of audit log entries to return. Accepts values from 1 up to 500 per request. Defaults to 50.
Offset Starting offset for pagination in the audit log list. Allows skipping a number of entries. Defaults to 0.

Output

The node outputs JSON data representing audit log entries retrieved from BookStack. Each item in the output corresponds to one audit log entry, containing details such as the action performed, timestamp, user information, and other relevant metadata provided by the BookStack API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the BookStack API.
  • The node depends on the BookStack API being accessible and properly configured.
  • No additional external services are required beyond the BookStack instance.

Troubleshooting

  • Common Issues:

    • Exceeding the maximum allowed limit (more than 500) will likely cause an error; ensure the "Limit" property stays within the allowed range.
    • Incorrect or missing API credentials will result in authentication errors.
    • Network connectivity issues to the BookStack server will prevent data retrieval.
  • Error Messages:

    • Errors returned from the BookStack API are surfaced as node operation errors with messages describing the issue.
    • If the node throws an error about missing parameters, verify that the "Limit" and "Offset" inputs are correctly set.
    • Authentication failures typically indicate invalid or expired API keys; reconfigure the credentials accordingly.

Links and References

Discussion