BIbitfocus

Get Connection status to Companion

Changed on
get/status

Request

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

Response

successful operation

connectedboolean required

Whether the client is connected to the Companion Satellite

companionVersionstring nullable required

Version of the Companion Satellite

companionApiVersionstring nullable required

API version of the Companion Satellite

companionUnsupportedApiboolean required

Whether the last successful Companion connection was with an unsupported API version

Changes

  • 0164120fcb88Revision changes
    • info

      added the required property to the response with the status

  • d030a952e19dRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status