Skip to main content
GET
Identifies a running Freedeck Server.

Response

200 - application/json

OK

title
string
Example:

"Freedeck"

version
string
Example:

"6.0.0-rc4"

plugins
string[]

A list of currently installed plugins.

webpackStatus
string

Can be any of 'uninitialized', 'compiling', or 'ready'. Used to halt immediate Companion connection to await bundles being fresh and ready.

Example:

"compiling"

deviceStatus
boolean

Whether or not the user's external Freedeck Client is connected

ip
string

The local IPs discovered on the machine.

myApp
object

MyFreedeck properties