Configuration

Update configuration value

PUT

https://firefly.example.com/api/v1/configuration/{name}

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

curl -X PUT 'https://firefly.example.com/api/v1/configuration/configuration.is_demo_site' \
  -H 'X-Trace-Id: 40c71bbb-c676-4f24-83cf-cc725d7d7a00' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  --data-raw 'value=true'

const response = await fetch('https://firefly.example.com/api/v1/configuration/configuration.is_demo_site', {
  method: 'PUT',
  headers: {
    'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/x-www-form-urlencoded',
  },
  body: 'value=true',
});

const data = await response.text();

import requests

response = requests.put(
    'https://firefly.example.com/api/v1/configuration/configuration.is_demo_site',
    data='value=true'.encode('utf-8'),
    headers={
        'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/x-www-form-urlencoded',
    },
)
print(response.text)

Request Body

{
  "value": true
}

{
  "value": true
}

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

{
  "message": "Bad Request",
  "exception": "BadRequestHttpException"
}

{
  "message": "Unauthenticated",
  "exception": "AuthenticationException"
}

{
  "message": "Resource not found",
  "exception": "NotFoundHttpException"
}

{
  "message": "The given data was invalid.",
  "errors": {
    "email": [
      "string"
    ],
    "force": [
      "string"
    ],
    "blocked": [
      "string"
    ],
    "field": [
      "string"
    ],
    "role": [
      "string"
    ],
    "blocked_code": [
      "string"
    ],
    "name": [
      "string"
    ],
    "type": [
      "string"
    ],
    "iban": [
      "string"
    ],
    "start": [
      "string"
    ],
    "end": [
      "string"
    ],
    "date": [
      "string"
    ]
  }
}

{
  "message": "Internal Exception",
  "exception": "InternalException"
}

Body

JSON array with the necessary account information or key=value pairs. See the model for the exact specifications.

application/x-www-form-urlencoded,application/jsonConfigurationUpdate

valueboolean | string | object | Array<StringArrayItem>required

Show child attributes

One of

boolean

string

object

Array<StringArrayItem>

Parameters

nameConfigValueUpdateFilterconfiguration.is_demo_siteconfiguration.permission_update_checkconfiguration.last_update_checkconfiguration.single_user_modeconfiguration.enable_exchange_ratesconfiguration.use_running_balanceconfiguration.enable_external_mapconfiguration.enable_external_ratesconfiguration.allow_webhooksconfiguration.valid_url_protocolsrequiredpath

The name of the configuration value you want to update.

Response

200OKConfigurationSingle

New configuration value stored, result in response.

Response fields application/json

dataConfigurationrequired

Show child attributes

titleConfigValueFilterconfiguration.is_demo_siteconfiguration.permission_update_checkconfiguration.last_update_checkconfiguration.single_user_modefirefly.versionfirefly.default_locationfirefly.account_to_transactionfirefly.allowed_opposing_typesfirefly.accountRolesfirefly.valid_liabilitiesfirefly.interest_periodsfirefly.enable_external_mapfirefly.expected_source_typesapp.timezonefirefly.bill_periodsfirefly.credit_card_typesfirefly.languagesfirefly.valid_view_rangescer.enabledfirefly.preselected_accountsfirefly.rule-actionsfirefly.context-rule-actionssearch.operatorswebhook.triggerswebhook.responseswebhook.deliveriesrequired

Title of the configuration value.

Example

configuration.is_demo_site

valueboolean | string | object | Array<StringArrayItem>required

Show child attributes

One of

boolean

string

object

Array<StringArrayItem>

editablebooleanrequired

If this config variable can be edited by the user

Example

true

400Bad RequestBadRequestResponse

Bad request

Response fields application/json

messagestring

Example

Bad Request

exceptionstring

Example

BadRequestHttpException

401UnauthorizedUnauthenticatedResponse

Unauthenticated

Response fields application/json

messagestring

Example

Unauthenticated

exceptionstring

Example

AuthenticationException

404Not FoundNotFoundResponse

Page not found

Response fields application/json

messagestring

Example

Resource not found

exceptionstring

Example

NotFoundHttpException

422Unprocessable EntityValidationErrorResponse

Validation error. The body will have the exact details.

Response fields application/json

messagestring

Example

The given data was invalid.

errorsobject

Show child attributes

emailArray<string>

forceArray<string>

blockedArray<string>

fieldArray<string>

roleArray<string>

blocked_codeArray<string>

nameArray<string>

typeArray<string>

ibanArray<string>

startArray<string>

endArray<string>

dateArray<string>

500Internal Server ErrorInternalExceptionResponse

Internal exception

Response fields application/json

messagestring

Example

Internal Exception

exceptionstring

Example

InternalException

Authorization

firefly_iii_authoauth2

OAuth2 authorization code flow. Create a client on your installation's /profile page; it authorizes at /oauth/authorize and issues tokens at /oauth/token there. The URLs below are the demo site's. How to use the API walks through it.

local_bearer_authhttp (bearer)

A Personal Access Token, sent as a bearer token. Create one on your installation under Options > Profile > OAuth > Personal Access Tokens.