BIbitfocus

Update current configuration

Changed on
post/config

Request

  • The document declares no server URL.
  • Auth
    none declared

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

detailedUsageEnabledboolean

Enable reporting of detailed usage statistics

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

detailedUsageEnabledboolean required

Enable reporting of detailed usage statistics

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

  • 1c8ede2d778fRevision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status

  • f99382b5ba92Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status