Jacob Kiers f0b8df90b9 Initial commit

This is definitely not functional yet.

Signed-off-by: Jacob Kiers <code@kiers.eu>

2024-10-04 20:31:39 +02:00

3.5 KiB

Raw Blame History

\AboutApi

All URIs are relative to https://demo.firefly-iii.org/api

Method	HTTP request	Description
get_about	GET /v1/about	System information end point.
get_cron	GET /v1/cron/{cliToken}	Cron job endpoint
get_current_user	GET /v1/about/user	Currently authenticated user endpoint.

get_about

models::SystemInfo get_about(x_trace_id) System information end point.

Returns general system information and versions of the (supporting) software.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::SystemInfo

Authorization

firefly_iii_auth, local_bearer_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_cron

models::CronResult get_cron(cli_token, x_trace_id, date, force) Cron job endpoint

Firefly III has one endpoint for its various cron related tasks. Send a GET to this endpoint to run the cron. The cron requires the CLI token to be present. The cron job will fire for all users.

Parameters

Name	Type	Description	Required
cli_token	String	The CLI token of any user in Firefly III, required to run the cron job.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
date	Option<String>	A date formatted YYYY-MM-DD. This can be used to make the cron job pretend it's running on another day.
force	Option<bool>	Forces the cron job to fire, regardless of whether it has fired before. This may result in double transactions or weird budgets, so be careful.