/
FA
falconchristmas
/
FPP API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2h ago · Updated 19h ago
View markdown
falconchristmas
FPP API
get
overlays/effects/{effect}
3b2b9c7c96bb
latest
OpenAPI 3.0.3
raw.githubusercontent.com
2026-08-11
257
0
236.3 KB
aes67
1
backups
11
cape
11
channel
6
command
3
commandPresets
2
commands
2
configfile
4
dir
2
effects
2
email
2
events
3
file
10
files
3
fppd
37
geoip
1
git
7
gpio
3
help
1
media
3
models
4
network
14
options
1
opusrtp
1
overlays
17
get
overlays/effects
get
overlays/effects/{effect}
get
overlays/fonts
get
overlays/model/{model}
get
overlays/model/{model}/clear
get
overlays/model/{model}/data
put
overlays/model/{model}/fill
put
overlays/model/{model}/mmap
put
overlays/model/{model}/pixel
get
overlays/model/{model}/preview
put
overlays/model/{model}/save
put
overlays/model/{model}/state
put
overlays/model/{model}/text
get
overlays/models
put
overlays/range/{ranges}
get
overlays/running
get
overlays/settings
pipewire
17
player
3
playlist
7
playlists
9
plugin
15
proxies
5
proxy
1
recurringtasks
2
remoteAction
1
remotes
1
schedule
3
scripts
4
sequence
9
settings
5
statistics
3
system
14
testmode
2
time
1
variables
4
overlays
overlays/effects/{effect}
Get the description of a single overlay effect.
get
/api/overlays/effects/{effect}
Response
The effect description.