Get Connection status to Companion

get/status

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

Changed in 3 of the 9 revisions of this API.31

Feb 2, 20250164120fcb881See the full diff
- ○
  added the required property companionUnsupportedApi to the response with the 200 status
  response-required-property-added
Feb 2, 2025d030a952e19d2See the full diff
- ▲
  the response property companionApiVersion became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property companionVersion became nullable for the status 200
  response-property-became-nullable
Feb 2, 2025dc40167d02781See the full diff
- ▲
  removed the required property companionUnsupportedApi 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