4.6 KiB
{{classname}}
All URIs are relative to https://demo.firefly-iii.org/api
| Method | HTTP request | Description |
|---|---|---|
| GetAbout | Get /v1/about | System information end point. |
| GetCron | Get /v1/cron/{cliToken} | Cron job endpoint |
| GetCurrentUser | Get /v1/about/user | Currently authenticated user endpoint. |
GetAbout
SystemInfo GetAbout(ctx, optional) System information end point.
Returns general system information and versions of the (supporting) software.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *AboutApiGetAboutOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a AboutApiGetAboutOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| xTraceId | optional.Interface of string | Unique identifier associated with this request. |
Return type
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]
GetCron
CronResult GetCron(ctx, cliToken, optional) 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.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| cliToken | string | The CLI token of any user in Firefly III, required to run the cron job. | |
| optional | *AboutApiGetCronOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a AboutApiGetCronOpts struct
| Name | Type | Description | Notes |
|---|
xTraceId | optional.Interface of string| Unique identifier associated with this request. | date | optional.String| A date formatted YYYY-MM-DD. This can be used to make the cron job pretend it's running on another day. | force | optional.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. |
Return type
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]
GetCurrentUser
UserSingle GetCurrentUser(ctx, optional) Currently authenticated user endpoint.
Returns the currently authenticated user.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *AboutApiGetCurrentUserOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a AboutApiGetCurrentUserOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| xTraceId | optional.Interface of string | Unique identifier associated with this request. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/vnd.api+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]