FPP 5.0 API Migration
Greg Hormann edited this page Mar 27, 2021
·
83 revisions
With FPP 5.0, the FPP will be deprecating the fppjson.php and fppxml.php APIs. Relevant end points will be ported to the REST api which is already documented on every FPP instance using /apihelp.php page. This document is being used to track progress. Where known, this also describes where external systems like xLights or older multi-sync interfaces depend on the legacy end point. Going forward, the follow conventions will be used for the REST API
- GET - Fetch value
- PUT - Update a value
- POST - Create new (or replace full)
- DELETE - Remove record
- Required parameters will appear as /api/base/:parm1/:parm2
- Optional parameters will be implemented as /api/base?parm1=val&parm2=val
- PROPOSED : Will be replaced by not designed yet
- PROPOSED : New Endpoint Proposed
- DESIGNED : End point agreed to by dev team but not yet implemented.
- API READY : End point implemented, but UI not updated to use it everywhere.
- COMPLETE : New Endpoint in Master and FPP Endpoint updated to use it.
- KEPT LEGACY : New Endpoint in Master and FPP Endpoint updated to use it but old API kept for backwards compatibility.
| Old Endpoint | New End Point | Used Externally by | Status |
|---|---|---|---|
| getOutputProcessors | GET /api/channel/output/processors | NONE | COMPLETE |
| setOutputProcessors | POST /api/channel/output/processors | NONE | COMPLETE |
| getChannelOutputs | GET /api/channel/output/:file | xLights (ALL) | KEPT LEGACY |
| setChannelOutputs | POST /api/channel/output/:file | xLights (ALL) | KEPT LEGACY |
| setUniverses | Remove? Not sure why this can't be UI only | NONE | PROPOSED |
| getDNSInfo | GET /api/network/dns | NONE | PROPOSED |
| setDNSInfo | POST /api/network/dns | NONE | PROPOSED |
| getFPPDUptime | Add to existing GET api/fppd/status | NONE | COMPLETE |
| applyInterfaceInfo | POST /api/network/interface/:interface/apply | NONE | COMPLETE |
| getInterfaceInfo | GET /api/network/interface/:interface | NONE | COMPLETE |
| setInterfaceInfo | POST /api/network/interface/:interface | NONE | COMPLETE |
| getFPPSystems | Merge with Existing GET /api/fppd/multiSyncSystems | xLights (ALL), MultiSync (<5.0) | KEPT LEGACY |
| getFPPstatus | GET api/system/status | MultiSync (<5.0)??? | KEPT LEGACY |
| getSetting | GET /api/settings/:SettingName | NONE | COMPLETE |
| setSetting | POST /api/settings/:SettingName | xLights (ALL) | COMPLETE |
| startSequence | GET /api/sequence/:SequenceName/start/:startSecond | NONE | COMPLETE |
| stopSequence | GET /api//sequence/current/stop | NONE | COMPLETE |
| toggleSequencePause | GET /api/sequence/current/togglePause | NONE | COMPLETE |
| singleStepSequence | GET /api/sequence/current/step | NONE | COMPLETE |
| singleStepSequenceBack | GET /api/sequence/current/stepBack | NONE | COMPLETE |
| getPlayListEntries | Enhance Existing GET /api/playlist/:PlaylistName mergeSubs as new Option |
NONE | COMPLETE |
| getSequenceInfo | Enhance GET /api/sequence/:SequenceName/meta | NONE | COMPLETE |
| getMediaDuration | Existing GET /media/:MediaName/duration | NONE | COMPLETE |
| getFileSize | GET /media/:MediaName/meta (May return more than size) |
NONE | COMPLETE |
| copyFile | POST /file/:DirName/copy/:source/:dest | NONE | COMPLETE |
| renameFile | POST /file/:DirName/rename/:source/:dest | NONE | COMPLETE |
| getPluginSetting | GET /api/plugin/:plugin/setting/:key | Plugins | PROPOSED |
| setPluginSetting | POST /api/plugin/:plugin/setting/:key | Plugins | PROPOSED |
| getPluginJSON | GET /api/plugin/:plugin/json | Plugins | PROPOSED |
| setPluginJSON | POST /api/plugin/:plugin/json | Plugins | PROPOSED |
| saveScript | POST /api/file/:Name | NONE | PROPOSED |
| setTestMode | POST /api/testmode | NONE | COMPLETE |
| getTestMode | GET /api/testmode | NONE | COMPLETE |
| setupExtGPIO | POST /api/GPIOSetup/:pin (mode is in payload) |
NONE | PROPOSED |
| extGPIO | POST /api/GPIO/:pin (mode and value in payload) |
NONE | PROPOSED |
| getSysInfo | Enhance GET /api/fppd/status | xLights(ALL), MultiSync | PROPOSED |
| getHostNameInfo | Enhance GET /api/fppd/status | MultiSync | PROPOSED |
| clearPersistentNetNames | DELETE /api/network/presisentNames | NONE | COMPLETE |
| createPersistentNetNames | POST /api/network/presisentNames | NONE | COMPLETE |
| Old Endpoint | New End Point | Used Externally by | Status |
|---|---|---|---|
| changeGitBranch | Use changebranch.php instead | NONE | COMPLETE |
| cloneUniverse | Move to GUI | NONE | PROPOSED |
| deleteEffect | DELETE /api/file/:Name | NONE | COMPLETE |
| deleteEvent | DEPRECATED | NONE | COMPLETE |
| deleteFile | DELETE /api/file/:DirName/:Name | NONE | COMPLETE |
| deleteUniverse | Move to GUI | NONE | PROPOSED |
| extGPIO | DEPRECATED - Use Command_ | NONE | COMPLETE |
| getBridgeInputDelayBeforeBlack | GET /api/settings/:SettingName | NONE | COMPLETE |
| getFiles | GET /api/files/:type | NONE | COMPLETE |
| getFile | GET /api/file/:name tail is optional parameter | NONE | COMPLETE |
| getFPPDmode | GET api/settings/fppMode | NONE | COMPLETE |
| getFPPstatus | GET /api/fppd/status | NONE | COMPLETE |
| getGitOriginLog | GET /api/git/originLog | NONE | COMPLETE |
| getInterfaceInfo | DROP -- Never Used | NONE | COMPLETE |
| getPixelnetDMXoutputs | GET /api/output/PixelnetDMX | NONE | PROPOSED |
| getRunningEffects | GET api/fppd/effects | NONE | PROPOSED |
| getUniverseReceivedBytes | GET /api/channel/input/stats | NONE | PROPOSED |
| getUniverses | GET /api/universes/ | NONE | PROPOSED |
| getVolume | GET /api/fppd/status | NONE | COMPLETE |
| getZip | GET /api/files/zip/:DirName | NONE | COMPLETE |
| gitStatus | GET /api/git/status | NONE | COMPLETE |
| installRemoteScript | GET /api/script/install/:category/:filename | NONE | COMPLETE |
| isFPPDrunning | GET /api/fppd/status | NONE | COMPLETE |
| moveFile | GET /api/file/move/:fileName | xLights | KEPT LEGACY |
| playEffect | DEPRECATED - Use Command API | NONE | COMPLETE |
| rebootPi | GET /api/system/reboot | MultiSync | KEPT LEGACY |
| resetGit | GET /api/git/reset | NONE | COMPLETE |
| restartFPPD | GET /api/fppd/restart | xLights(All), Multisync | KEPT LEGACY |
| saveEvent | DEPRECATED | NONE | COMPLETE |
| saveUSBDongle | POST /api/settings/:SettingName | NONE | COMPLETE |
| setBridgeInputDelayBeforeBlack | PUT /api/settings/:SettingName | NONE | COMPLETE |
| setFPPDmode | POST api/settings/fppMode | xLights(All), Multisync | KEPT LEGACY |
| setUniverseCount | DEPRECATE - Move to UI | NONE | PROPOSED |
| setupExtGPIO | DEPRECATED - Use Command_ | NONE | COMPLETE |
| setVolume | POST /api/system/volume | NONE | COMPLETE |
| shutdownPi | GET /api/system/shutdown | Multisync | KEPT LEGACY |
| startFPPD | GET /api/system/fppd/start | NONE | COMPLETE |
| startPlaylist | POST /api/command | NONE | COMPLETE |
| stopEffectByName | DEPRECATE - Use Commands API | NONE | COMPLETE |
| stopEffect | DEPRECATE - Use Commands API | NONE | COMPLETE |
| stopFPPD | GET /api/fppd/stop | NONE | COMPLETE |
| stopGracefullyAfterLoop | DEPRECATE - Use Commands API | NONE | COMPLETE |
| stopGracefully | DEPRECATE - Use Commands API | NONE | COMPLETE |
| stopNow | DEPRECATE - Use Commands API | NONE | COMPLETE |
| tailFile | GET /api/file/:name tail is optional parameter | NONE | COMPLETE |
| triggerEvent | DEPRECATE - Use Commands API | xLights(all) | COMPLETE |
| upgradeFPPVersion | DEPRECATED - replaced by upgradefpp.php | NONE | COMPLETE |
| viewReleaseNotes | GET /api/system/releaseNotes/:version | NONE | COMPLETE |
| viewRemoteScript | GET /api/scripts/viewRemote/:category/:filename | NONE | COMPLETE |