---
title: "Get current configuration"
method: GET
path: "/config"
---

# Get current configuration

`GET /config`

## Response `200`

successful operation

- ConfigData
  - `protocol` 'tcp' | 'ws', required — Protocol to use for the connection
  - `host` string, required — Address of the Companion server to connect to, for TCP protocol
  - `port` number, required — Port number of the Companion server to connect to, for TCP protocol
  - `wsAddress` string, required — Address of the Companion server to connect to, for WS protocol
  - `installationName` string, required — Name of the installation, reported in the mDNS announcement
  - `mdnsEnabled` boolean, required — Enable mDNS announcement to allow automatic discovery of the Companion Satellite
  - `httpEnabled` boolean, required — Enable the HTTP api. This is readonly in the HTTP api
  - `httpPort` number, required — Port number of the HTTP api. This is readonly in the HTTP api

## Other responses

- `400` — failed operation

## Changes

- **2025-02-02** `f99382b5ba92` — 2 info
  - added the required property `protocol` to the response with the `200` status
  - added the required property `wsAddress` to the response with the `200` status
- **2025-02-02** `dc40167d0278` — 2 breaking
  - removed the required property `protocol` from the response with the `200` status
  - removed the required property `wsAddress` from the response with the `200` status

[Change history](https://skmtc.dev/bitfocus/apis/bitfocus-companion-satellite-configuration-api/changes/config/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)