Actions45
- General Actions
- About API Actions
- Accounts API Actions
- Transactions API Actions
- Categories API Actions
- Tags API Actions
- Rules & Groups API Actions
Overview
This node integrates with the FireFly III API to retrieve general system information and user details about the FireFly III instance. Specifically, the "About API" resource with the "Get General System Info" operation fetches metadata such as version info, system status, and other relevant system-wide data.
Use cases include:
- Monitoring the FireFly III server status and version.
- Retrieving system metadata for logging or auditing purposes.
- Debugging or verifying the environment before performing further API operations.
Example: You might use this node to periodically check the FireFly III system version and ensure it matches your expected deployment, or to confirm that the API is reachable and responding correctly.
Properties
| Name | Meaning |
|---|---|
| X-Trace-ID | A unique UUID identifier for the request, used for debugging and tracing (e.g., 123e4567-e89b-12d3-a456-426614174000). |
Additionally, there is a notice property linking to the FireFly III API Documentation for users to learn more about available endpoints.
Output
The output JSON contains the general system information returned by the FireFly III /about endpoint. This typically includes:
- Version details of the FireFly III instance.
- System metadata such as build info, environment, or uptime.
- Other descriptive information about the running FireFly III server.
The exact structure depends on the FireFly III API response but generally provides a snapshot of the system's current state.
No binary data output is produced by this operation.
Dependencies
- Requires an authenticated connection to a FireFly III instance via an OAuth2 API credential or equivalent API authentication token.
- The node uses internal helper functions to make HTTP requests to the FireFly III REST API.
- Network access to the FireFly III server must be configured and allowed from the n8n environment.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Network connectivity problems to the FireFly III server will result in request timeouts or connection errors.
- Providing an invalid UUID format for the X-Trace-ID may not cause failure but could affect tracing/debugging.
Error messages:
- Authentication errors typically indicate incorrect or expired API tokens; re-authenticate or update credentials.
- HTTP 404 or 500 errors suggest the FireFly III server endpoint is unreachable or misconfigured.
- JSON parsing errors may occur if the API response is malformed or unexpected.
To resolve these, verify credentials, network connectivity, and ensure the FireFly III server is operational and accessible.