Sign in

Update current configuration

post/config

Request body

protocol'tcp' | 'ws'

Protocol to use for the connection

hoststring

Address of the Companion server to connect to, for TCP protocol

portnumber

Port number of the Companion server to connect to, for TCP protocol

wsAddressstring

Address of the Companion server to connect to, for WS protocol

installationNamestring

Name of the installation, reported in the mDNS announcement

mdnsEnabledboolean

Enable mDNS announcement to allow automatic discovery of the Companion Satellite

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.224

  • f99382b5ba924See the full diff
    • ○

      added the new optional request property protocol

      new-optional-request-property

    • ○

      added the new optional request property wsAddress

      new-optional-request-property

    • ○

      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

  • dc40167d027822See 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

    • ●

      removed the request property protocol

      request-property-removed

    • ●

      removed the request property wsAddress

      request-property-removed

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