command

Run a command by name via GET, passing arguments as extra path segments (e.g. /api/command/Volume%20Set/50).

Changed on

An argument may contain %VAR:name% to substitute a User Variable's current value, as anywhere else a command's arguments are given. Percent-encode it as %25VAR:name%25: sent raw, %VA is an invalid escape and Apache rejects the request with a 400 before it reaches FPP. An unset variable substitutes as an empty string. Note that empty path segments collapse, so an argument that should be empty cannot be passed this way - use the POST form below for that. Deprecated: FPP 11 will require one of the POST forms below.

get/api/command/{command}

Request

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

Response

Command result (text/plain).

Changes