configuration

Update configuration value

Changed on

Set a single configuration value. Not all configuration values can be updated so the list of accepted configuration variables is small.

put/v1/configuration/{name}

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/configuration/{name}
  • Auth
    • OAuth 2
      Authorization code: https://demo.firefly-iii.org/oauth/authorize
      Token URL: https://demo.firefly-iii.org/oauth/token
    • or HTTP bearer

Path parameters

name'configuration.is_demo_site' | 'configuration.permission_update_check' | 'configuration.last_update_check' | 'configuration.single_user_mode' | 'configuration.enable_exchange_rates' | 'configuration.use_running_balance' | 'configuration.enable_external_map' | 'configuration.enable_external_rates' | 'configuration.allow_webhooks' | 'configuration.valid_url_protocols' required

The name of the configuration value you want to update.

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

Example request

{
  "value": [
    "EUR"
  ]
}

Response

New configuration value stored, result in response.

Example response

{
  "data": {
    "title": "configuration.is_demo_site",
    "value": [
      "EUR"
    ],
    "editable": true
  }
}

Changes

    • info

      added the new enum value configuration.allow_webhooks to the path request parameter name

    • info

      added the new enum value configuration.enable_exchange_rates to the path request parameter name

    • info

      added the new enum value configuration.enable_external_map to the path request parameter name

    • info

      added the new enum value configuration.enable_external_rates to the path request parameter name

    • info

      added the new enum value configuration.use_running_balance to the path request parameter name

    • info

      added the new enum value configuration.valid_url_protocols to the path request parameter name