5.1 KiB
{{classname}}
All URIs are relative to https://demo.firefly-iii.org/api
| Method | HTTP request | Description |
|---|---|---|
| GetConfiguration | Get /v1/configuration | Get Firefly III system configuration values. |
| GetSingleConfiguration | Get /v1/configuration/{name} | Get a single Firefly III system configuration value |
| SetConfiguration | Put /v1/configuration/{name} | Update configuration value |
GetConfiguration
[]Configuration GetConfiguration(ctx, optional) Get Firefly III system configuration values.
Returns all editable and not-editable configuration values for this Firefly III installation
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *ConfigurationApiGetConfigurationOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a ConfigurationApiGetConfigurationOpts 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/x-www-form-urlencoded
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetSingleConfiguration
ConfigurationSingle GetSingleConfiguration(ctx, name, optional) Get a single Firefly III system configuration value
Returns one configuration variable for this Firefly III installation
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| name | ConfigValueFilter | The name of the configuration value you want to know. | |
| optional | *ConfigurationApiGetSingleConfigurationOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a ConfigurationApiGetSingleConfigurationOpts 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]
SetConfiguration
ConfigurationSingle SetConfiguration(ctx, value, body, name, optional) Update configuration value
Set a single configuration value. Not all configuration values can be updated so the list of accepted configuration variables is small.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| value | PolymorphicProperty | ||
| body | ConfigurationUpdate | JSON array with the necessary account information or key=value pairs. See the model for the exact specifications. | |
| name | ConfigValueUpdateFilter | The name of the configuration value you want to update. | |
| optional | *ConfigurationApiSetConfigurationOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a ConfigurationApiSetConfigurationOpts 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: application/x-www-form-urlencoded, application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]