BookStack

Consume BookStack API

Actions40

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 Role resource with the Get Many operation, it retrieves a list of role resources from the BookStack system.

Common scenarios where this node is beneficial include:

Fetching all user roles defined in a BookStack instance to audit permissions.
Integrating role data into workflows that require role-based access control or reporting.
Synchronizing roles between BookStack and other systems.

Example: You want to get a list of all roles available in your BookStack documentation platform to display them in a dashboard or use them in an automation workflow.

Properties

Name	Meaning
Tool Description	Choose how to determine the resource and operation: - Set Automatically - Set Manually
Request Description	(Shown only if "Set Automatically" is selected) A text description of what you want to do. The system uses this to automatically select the appropriate resource and operation. Example: "List all roles"

Note: Since the Resource is fixed to "Role" and Operation to "Get Many", no additional parameters specific to Role are required for this operation.

Output

The output is an array of JSON objects representing the retrieved roles. Each item corresponds to one role resource fetched from the BookStack API.

The structure of each JSON object matches the API response for a role, typically including fields like role ID, name, permissions, and other metadata.

No binary data is output by this node.

Example output snippet (simplified):

[
  {
    "id": 1,
    "name": "Admin",
    "permissions": [...],
    ...
  },
  {
    "id": 2,
    "name": "Editor",
    "permissions": [...],
    ...
  }
]

Dependencies

Requires an API key credential for authenticating with the BookStack API.
The node expects the base URL of the BookStack instance and authentication tokens to be configured in the credentials.
Uses HTTP GET requests to the /roles endpoint of the BookStack API.

Troubleshooting

Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Invalid base URL or network connectivity issues can prevent API calls.
- If the BookStack API version changes, some fields in the response might differ.
Error messages:
- Authentication errors usually indicate invalid or expired tokens; verify and update credentials.
- HTTP 404 or similar errors may mean the API endpoint is incorrect or the resource does not exist.
- Rate limiting or server errors should be retried after some delay.