---
title: "Get Connection status to Companion"
method: GET
path: "/status"
---

# Get Connection status to Companion

`GET /status`

## Response `200`

successful operation

- StatusResponse
  - `connected` boolean, required — Whether the client is connected to the Companion Satellite
  - `companionVersion` string, nullable, required — Version of the Companion Satellite
  - `companionApiVersion` string, nullable, required — API version of the Companion Satellite
  - `companionUnsupportedApi` boolean, required — Whether the last successful Companion connection was with an unsupported API version

## Other responses

- `400` — failed operation

## Changes

- **2025-02-02** `0164120fcb88` — 1 info
  - added the required property `companionUnsupportedApi` to the response with the `200` status
- **2025-02-02** `d030a952e19d` — 2 breaking
  - the response property `companionApiVersion` became nullable for the status `200`
  - the response property `companionVersion` became nullable for the status `200`
- **2025-02-02** `dc40167d0278` — 1 breaking
  - removed the required property `companionUnsupportedApi` from the response with the `200` status

[Change history](https://skmtc.dev/bitfocus/apis/bitfocus-companion-satellite-configuration-api/changes/status/get.md)

---

[API](https://skmtc.dev/bitfocus/apis/bitfocus-companion-satellite-configuration-api.md) · [All operations](https://skmtc.dev/bitfocus/apis/bitfocus-companion-satellite-configuration-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bitfocus/bitfocus-companion-satellite-configuration-api/revisions/f6c98cf1869f/schema)
