daemon_config

🔴 Unstable

This API's output may be changed in the future.

Retrieve the active configuration of festivald.

The output is almost a mirror of the configuration file.

See the Config chapter to see the full description of these fields.

The reason why this method is 🔴 Unstable is because it will output all JSON-RPC methods & REST resources, even 🔴 Unstable ones, which may not exist in the future.

Inputs

None

Outputs

FieldType
ipstring (IPv4 address)
portunsigned integer
max_connectionsoptional (maybe-null) unsigned integer
exclusive_ipsoptional (maybe-null) array of strings (IPv4 addresses)
sleep_on_failoptional (maybe-null) unsigned integer
collection_pathsarray of strings (PATHs)
tlsboolean
certificateoptional (maybe-null) string (PATH)
keyoptional (maybe-null) string (PATH)
restboolean
docsboolean
direct_downloadboolean
filename_separatorstring
log_levelstring, one of OFF, ERROR, WARN, INFO, DEBUG, ERROR
watchboolean
cache_cleanboolean
cache_timeunsigned integer
restore_audio_stateboolean
media_controlsboolean
authorizationboolean
confirm_no_tls_authboolean
no_auth_rpcoptional (maybe-null) array of JSON-RPC Method names
no_auth_restoptional (maybe-null) array of REST Resource names
no_auth_docsboolean

Example Request

festival-cli daemon_config

curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"daemon_config"}'

Example Response

{
  "jsonrpc": "2.0",
  "result": {
    "ip": "127.0.0.1",
    "port": 18425,
    "max_connections": null,
    "exclusive_ips": null,
    "sleep_on_fail": 3000,
    "collection_paths": [
      "/home/hinto/Music"
    ],
    "tls": true,
    "certificate": "/home/hinto/festival/assets/tls/cert.pem",
    "key": "/home/hinto/festival/assets/tls/key.pem",
    "rest": true,
    "docs": true,
    "direct_download": false,
    "filename_separator": " - ",
    "log_level": "TRACE",
    "watch": true,
    "cache_clean": true,
    "cache_time": 3600,
    "restore_audio_state": true,
    "media_controls": true,
    "authorization": true,
    "confirm_no_tls_auth": false,
    "no_auth_rpc": [
      "toggle"
    ],
    "no_auth_rest": [
      "song"
    ],
    "no_auth_docs": true
  },
  "id": 0
}