Actions56
- Book Actions
- Page Actions
- Chapter Actions
- Shelf Actions
- User Actions
- Role Actions
- Attachment Actions
- Tag Actions
Overview
This node integrates with the BookStack API to manage various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the Attachment resource with the Get Many operation, it retrieves multiple attachment records from the BookStack system.
Common scenarios where this node is beneficial include:
- Fetching all attachments related to a specific book, page, or chapter for reporting or backup.
- Listing files uploaded in the BookStack environment to synchronize with other systems.
- Automating retrieval of attachments for further processing or analysis.
Practical example:
- A user wants to list all attachments available in their BookStack instance to generate a report of all uploaded files. They configure the node to use the Attachment resource and Get Many operation, which returns all attachments in JSON format.
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) Describe your request in natural language; the system attempts to infer the appropriate resource and operation based on this description. Example: "List all attachments" |
Note: For this specific Resource-Operation (Attachment - Get Many), typically the "Tool Description" would be set manually or automatically, but no additional parameters are required to fetch many attachments.
Output
The output is an array of JSON objects representing the retrieved attachments. Each object corresponds to one attachment resource as returned by the BookStack API under the /attachments endpoint.
The structure of each JSON object depends on the BookStack API's response schema for attachments, typically including fields like attachment ID, name, URL, associated entity (book/page/chapter), upload date, and metadata.
No binary data output is produced by this operation; it strictly returns JSON data describing the attachments.
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.
- The BookStack API must be accessible from the n8n environment.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Network connectivity problems to the BookStack server will result in request timeouts or errors.
- If the BookStack API version changes or the endpoint
/attachmentsis deprecated, the node may fail to retrieve data.
Error messages:
- Authentication errors typically indicate invalid or expired API tokens; verify and update credentials.
- HTTP 404 errors suggest the endpoint or resource does not exist; confirm the BookStack API URL and resource availability.
- Rate limiting or quota exceeded errors require checking BookStack API usage policies.