Get configuration

GET /client/taps/{id}/configuration

Get configuration

cURL

curl --request GET \
  --url https://api.orbital-systems.com/client/taps/{id}/configuration \
  --header 'x-api-key: <api-key>'

200

{
  "active_timeout_s": 123,
  "default_flow": 123,
  "default_temp": 123,
  "min_flow": 123,
  "min_temp": 123,
  "max_flow": 123,
  "max_temp": 123,
  "theme": 123,
  "time_zone": "<string>",
  "time_zone_name": "<string>",
  "units": 123,
  "wall_clock_enabled": true,
  "welcome_message_enabled": true,
  "welcome_message": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

id · string · required

The tap ID

Response

200

application/json

Success

active_timeout_s · number

default_flow · number

default_temp · number

min_flow · number

min_temp · number

max_flow · number

max_temp · number

theme · number

time_zone · string

time_zone_name · string

units · number

wall_clock_enabled · boolean

welcome_message_enabled · boolean

welcome_message · string