Actions89
- General Actions
- About API Actions
- Accounts API Actions
- Available Budgets API Actions
- Bills API Actions
- Budgets API Actions
- Transactions API Actions
- Categories API Actions
- Tags API Actions
- Rules & Groups API Actions
- Piggy Banks API Actions
- Object Groups API Actions
- Recurrences API Actions
About API → Cron Jobs Endpoint
AI-generatedOverview
This node operation allows users to run cron jobs on the Firefly III system via its API. It is useful for automating scheduled tasks within Firefly III, such as triggering periodic financial processes or maintenance routines. Users provide a CLI token for authentication and can optionally specify a date to simulate running the cron job on a different day or force the cron job to run regardless of previous executions.
Use Case Examples
- Automate monthly budget recalculations by running the cron job on the first day of each month.
- Force a cron job to run immediately to apply recent changes without waiting for the scheduled time.
Properties
| Name | Meaning |
|---|---|
| X-Trace-ID | A unique UUID identifier for the request, used for debugging and tracing. |
| CLI Token | The CLI token of any user in Firefly III, required to run the cron job. |
| Additional Options | Optional parameters to modify the cron job execution, including 'Date' to simulate running on another day and 'Force' to force the cron job to fire regardless of previous runs. |
Output
JSON
json- The JSON response from the Firefly III API after running the cron job, containing the result or status of the cron job execution.
Dependencies
- Requires an API key credential (CLI token) for authentication with the Firefly III API.
Troubleshooting
- Ensure the CLI token is valid and has the necessary permissions to run cron jobs in Firefly III.
- If the cron job does not run as expected, verify the 'Date' format is correct (YYYY-MM-DD) and that the 'Force' option is used cautiously to avoid duplicate data.
- Check network connectivity and API endpoint availability if requests fail.
Links
- Firefly III API Documentation - Official API documentation site for Firefly III, providing detailed information on endpoints including the cron jobs endpoint.