variables

List all User Variables and their current values. Pass ?validateExpression instead to syntax-check an expression (for the Set Variable "Expression" field) against currently-known variables, without setting anything. Pass ?fpp=true instead to list the read-only "fpp_" status variables (current playlist/sequence, play state, volume, etc.) instead of User Variables.

get/api/variables

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/variables
  • Auth
    none declared

Query parameters

validateExpressionstring

If set, validate this expression instead of listing variables.

conditionExprboolean

If "true" alongside validateExpression, classify it the way the If

fppboolean

If "true", list the read-only fpp- status variables instead of User Variables.

mqttboolean

If "true", list the read-only mqtt-<topic> variables (MQTT's own last-message-

Response

Object keyed by variable name, each with value, truncated,

Changes