Sign in

Get 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

Changes

Changed in 2 of the 9 revisions of this API.22

  • f99382b5ba922See the full diff
    • ○

      added the required property protocol to the response with the 200 status

      response-required-property-added

    • ○

      added the required property wsAddress to the response with the 200 status

      response-required-property-added

  • dc40167d02782See the full diff
    • ▲

      removed the required property protocol from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property wsAddress from the response with the 200 status

      response-required-property-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog