v1
latestOpenAPI 3.0.02026-07-17868.5 KBGet current configuration
get/config
Response
successful operation
protocol'tcp' | 'ws' required
Protocol to use for the connection
hoststring required
Address of the Companion server to connect to, for TCP protocol
portnumber required
Port number of the Companion server to connect to, for TCP protocol
wsAddressstring required
Address of the Companion server to connect to, for WS protocol
installationNamestring required
Name of the installation, reported in the mDNS announcement
mdnsEnabledboolean required
Enable mDNS announcement to allow automatic discovery of the Companion Satellite
httpEnabledboolean required
Enable the HTTP api. This is readonly in the HTTP api
httpPortnumber required
Port number of the HTTP api. This is readonly in the HTTP api