FPP API Documentation

[daunce]

I'm not sure if I'm having a bad morning, but I'm not able to find much in the way of doco for FPP API.

There's mentions of the API in release notes and forums. I've found some pages like https://falcon-player.gitbooks.io/api-documentation & https://fppapi.docs.apiary.io, but any GET https://{{fpp}}/api/files returns connection refused.

There's some doco around xSchedule API, so is that the way to go if wanting to interact with the API?

There's no real use case at the moment. I'm just exploring, but I'd like to see about updating text on a matrix from an API call.

 

[darylc]

try http:// ? I doubt FPP supports https.

 

[daunce]

ah that changed things, thanks @darylc. I type https out of habit these days.

api/playlists returns valid results.. but I'm going through others trial and error.. a lot, like api/config/network return 404.

Is there a list of commands available?

 

[dkulp]

The two places to look:

http://{{fpp}}/api/help

and

http://{{fpp}}/api/commands

The first lists most of the general REST api's. The second lists the commands that can be hit. All of them can be invoked either via GET (http://{{fpp}}/api/command/CommandName/arg1/arg2/.... ) or via POST to http://{{fpp}}api/command/CommandName where the payload is a JSON array of strings.

 

[daunce]

ahhh.. Thanks @dkulp. Of course /api/help seems obvious now ;-) I even went through the help drop down menu in FPP with no luck.

I have a change freeze in place with 1 week to go before lights on Might be too close to Dec 1 to upgrade to FPP 3.5 for me to get the additional commands, but I might use my spare rPi to test.

Appreciate the help mate.