Skip to main content
API docs by Redocly

Watergate Cloud API (2025.1.0)

Authentication

This API uses Bearer Token authentication with a refresh token flow.

Step 1 - Login

Use your credentials to authenticate and get an access_token and refresh_token.

Step 2 - Use Access Token

Include the access_token in the Authorization header:

Authorization: Bearer your_token_here

### Step 3 - Refresh
When your access token expires, use the `refresh_token` to get a new access token.

---
Tokens must be kept secure. Never expose them in public repositories or client-side code.

Incidents

Retrieve all accessible incidents

Authorizations:
BearerAuth
query Parameters
type
string
Enum: "high_volume_alert" "long_flow_alert" "device_handle_moved" "battery_too_low_to_move_handle" "radio_disconnection" "cloud_disconnection" "pressure_test_failed" "pressure_test_skipped" "pressure_test_aborted" "health_check_failed" "low_battery_level" "legionella_risk" "legionella_high_risk" "low_water_temperature" "water_presence_detected" "low_temperature" "high_temperature" "high_humidity" "advanced_valve_misalignment" "backup_battery_usage"
open
boolean
page
integer

Page number that is used for the pagination.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page_number": 1,
  • "page_size": 10,
  • "total_entries": 10,
  • "total_pages": 2
}

Get an incident

Authorizations:
BearerAuth
path Parameters
id
required
string

Incident UUID

Responses

Response samples

Content type
application/json
{
  • "detected_at": "2021-06-21T18:28:00.717720Z",
  • "id": "3a9c7416-ff53-48d1-b667-99e822eec29b",
  • "open": false,
  • "possible_actions": [
    ],
  • "severity": "high",
  • "signal_id": "3a9c7416-ff53-48d1-b667-99e822ee0010",
  • "sonic_id": "3a9c7416-ff53-48d1-b667-99e822ee0011",
  • "state": "resolved",
  • "type": "long_flow_alert"
}

Transition an incident to a different state

Authorizations:
BearerAuth
path Parameters
incident_id
required
string

Incident UUID

Request Body schema: application/json
optional

Body

action
string

An action transitioning the incident to another state e.g. resolved.

Responses

Request samples

Content type
application/json
{
  • "action": "string"
}

Response samples

Content type
application/json
{
  • "detected_at": "2021-06-21T18:28:00.717720Z",
  • "id": "3a9c7416-ff53-48d1-b667-99e822eec29b",
  • "open": false,
  • "possible_actions": [
    ],
  • "severity": "high",
  • "signal_id": "3a9c7416-ff53-48d1-b667-99e822ee0010",
  • "sonic_id": "3a9c7416-ff53-48d1-b667-99e822ee0011",
  • "state": "resolved",
  • "type": "long_flow_alert"
}

Retrieve all incidents for property

Authorizations:
BearerAuth
path Parameters
property_id
required
string

Property UUID

query Parameters
type
string
Enum: "high_volume_alert" "long_flow_alert" "device_handle_moved" "battery_too_low_to_move_handle" "radio_disconnection" "cloud_disconnection" "pressure_test_failed" "pressure_test_skipped" "pressure_test_aborted" "health_check_failed" "low_battery_level" "legionella_risk" "legionella_high_risk" "low_water_temperature" "water_presence_detected" "low_temperature" "high_temperature" "high_humidity" "advanced_valve_misalignment" "backup_battery_usage"
open
boolean
page
integer

Page number that is used for the pagination.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page_number": 1,
  • "page_size": 10,
  • "total_entries": 10,
  • "total_pages": 2
}

Properties

Retrieve all accessible properties

Authorizations:
BearerAuth
query Parameters
name
string

Property name

membership_role
string

Membership role of requesting user, one of: owner, user, guest.

search
string

Search parameter to filter properties

page
integer

Page number that is used for the pagination.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page_number": 1,
  • "page_size": 10,
  • "total_entries": 10,
  • "total_pages": 2
}

Get property

Authorizations:
BearerAuth
path Parameters
id
required
string

Property UUID

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "address": "Kensington Gardens",
  • "city": "London",
  • "country": "United Kingdom",
  • "created_at": "2022-01-22T10:20:30.000Z",
  • "id": "7bcb5fe0-abcd-25e7-93c5-6e6a71c123d2",
  • "lat": 51.5158392,
  • "lng": -0.1114453,
  • "name": "Kensington Gardens",
  • "postcode": "W8 4PX",
  • "uprn": ""
}

Modify property

Authorizations:
BearerAuth
path Parameters
id
required
string

Property UUID

Request Body schema: application/json
optional

Body

active
boolean

Whether the property is active or not

address
string

Property address

city
string

Property city

country
string

Property country

created_at
string

Date when the property has been created.

lat
number

Property latitude

lng
number

Property longitude

name
string

Property name

postcode
string

Property postcode

uprn
string

Property uprn

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "address": "Kensington Gardens",
  • "city": "London",
  • "country": "United Kingdom",
  • "created_at": "2022-01-22T10:20:30.000Z",
  • "lat": 51.5158392,
  • "lng": -0.1114453,
  • "name": "Kensington Gardens",
  • "postcode": "W8 4PX",
  • "uprn": ""
}

Response samples

Content type
application/json
{
  • "active": true,
  • "address": "Kensington Gardens",
  • "city": "London",
  • "country": "United Kingdom",
  • "created_at": "2022-01-22T10:20:30.000Z",
  • "id": "7bcb5fe0-abcd-25e7-93c5-6e6a71c123d2",
  • "lat": 51.5158392,
  • "lng": -0.1114453,
  • "name": "Kensington Gardens",
  • "postcode": "W8 4PX",
  • "uprn": ""
}

Modify property

Authorizations:
BearerAuth
path Parameters
id
required
string

Property UUID

Request Body schema: application/json
optional

Body

active
boolean

Whether the property is active or not

address
string

Property address

city
string

Property city

country
string

Property country

created_at
string

Date when the property has been created.

lat
number

Property latitude

lng
number

Property longitude

name
string

Property name

postcode
string

Property postcode

uprn
string

Property uprn

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "address": "Kensington Gardens",
  • "city": "London",
  • "country": "United Kingdom",
  • "created_at": "2022-01-22T10:20:30.000Z",
  • "lat": 51.5158392,
  • "lng": -0.1114453,
  • "name": "Kensington Gardens",
  • "postcode": "W8 4PX",
  • "uprn": ""
}

Response samples

Content type
application/json
{
  • "active": true,
  • "address": "Kensington Gardens",
  • "city": "London",
  • "country": "United Kingdom",
  • "created_at": "2022-01-22T10:20:30.000Z",
  • "id": "7bcb5fe0-abcd-25e7-93c5-6e6a71c123d2",
  • "lat": 51.5158392,
  • "lng": -0.1114453,
  • "name": "Kensington Gardens",
  • "postcode": "W8 4PX",
  • "uprn": ""
}

Retrieve all incidents for property

Authorizations:
BearerAuth
path Parameters
property_id
required
string

Property UUID

query Parameters
type
string
Enum: "high_volume_alert" "long_flow_alert" "device_handle_moved" "battery_too_low_to_move_handle" "radio_disconnection" "cloud_disconnection" "pressure_test_failed" "pressure_test_skipped" "pressure_test_aborted" "health_check_failed" "low_battery_level" "legionella_risk" "legionella_high_risk" "low_water_temperature" "water_presence_detected" "low_temperature" "high_temperature" "high_humidity" "advanced_valve_misalignment" "backup_battery_usage"
open
boolean
page
integer

Page number that is used for the pagination.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page_number": 1,
  • "page_size": 10,
  • "total_entries": 10,
  • "total_pages": 2
}

Get property notification settings

Authorizations:
BearerAuth
path Parameters
property_id
required
string

Property UUID

Responses

Response samples

Content type
application/json
{
  • "battery_too_low_to_move_handle": true,
  • "cloud_disconnection": true,
  • "device_handle_moved": true,
  • "health_check_failed": true,
  • "high_humidity": true,
  • "high_humidity_threshold": true,
  • "high_temperature": true,
  • "high_temperature_threshold": true,
  • "high_volume_threshold_litres": 200,
  • "legionella_risk": true,
  • "long_flow_notification_delay_mins": 60,
  • "low_battery_level": true,
  • "low_temperature": true,
  • "low_temperature_threshold": true,
  • "low_water_temperature": true,
  • "pressure_test_failed": true,
  • "pressure_test_skipped": true,
  • "radio_disconnection": true,
  • "water_presence_detected": true
}

Modify property notification settings

Authorizations:
BearerAuth
path Parameters
property_id
required
string

Property UUID

Request Body schema: application/json
optional

Body

battery_too_low_to_move_handle
boolean

Handle couldn't be moved due to low battery notification

cloud_disconnection
boolean

Cloud disconnection notification (e.g. internet failure)

device_handle_moved
boolean

Handle moved notification (e.g. manually closing the valve)

health_check_failed
boolean

Health check failed notification

high_humidity
boolean

High humidity notification

high_humidity_threshold
boolean

High humidity notification threshold

high_temperature
boolean

High temperature notification

high_temperature_threshold
boolean

High temperature notification threshold

high_volume_threshold_litres
integer

Send a notification when we identify water is constantly running and the volume is more than X liters.

legionella_risk
boolean

Legionella stagnation and temperature checks will made every day if true

long_flow_notification_delay_mins
integer

Send a notification when we identify water is constantly running for over than X mins.

low_battery_level
boolean

Low battery notification

low_temperature
boolean

Low temperature notification

low_temperature_threshold
boolean

Low temperature notification threshold

low_water_temperature
boolean

Low water temperature notification

pressure_test_failed
boolean

Pressure test failed notification

pressure_test_skipped
boolean

Pressure test skipped notification

radio_disconnection
boolean

Radio disconnection notification (e.g. Sonic cannot connect to Bridge)

water_presence_detected
boolean

Water presence detected notification

Responses

Request samples

Content type
application/json
{
  • "battery_too_low_to_move_handle": true,
  • "cloud_disconnection": true,
  • "device_handle_moved": true,
  • "health_check_failed": true,
  • "high_humidity": true,
  • "high_humidity_threshold": true,
  • "high_temperature": true,
  • "high_temperature_threshold": true,
  • "high_volume_threshold_litres": 200,
  • "legionella_risk": true,
  • "long_flow_notification_delay_mins": 60,
  • "low_battery_level": true,
  • "low_temperature": true,
  • "low_temperature_threshold": true,
  • "low_water_temperature": true,
  • "pressure_test_failed": true,
  • "pressure_test_skipped": true,
  • "radio_disconnection": true,
  • "water_presence_detected": true
}

Response samples

Content type
application/json
{
  • "battery_too_low_to_move_handle": true,
  • "cloud_disconnection": true,
  • "device_handle_moved": true,
  • "health_check_failed": true,
  • "high_humidity": true,
  • "high_humidity_threshold": true,
  • "high_temperature": true,
  • "high_temperature_threshold": true,
  • "high_volume_threshold_litres": 200,
  • "legionella_risk": true,
  • "long_flow_notification_delay_mins": 60,
  • "low_battery_level": true,
  • "low_temperature": true,
  • "low_temperature_threshold": true,
  • "low_water_temperature": true,
  • "pressure_test_failed": true,
  • "pressure_test_skipped": true,
  • "radio_disconnection": true,
  • "water_presence_detected": true
}

Get property settings

Authorizations:
BearerAuth
path Parameters
property_id
required
string

Property UUID

Responses

Response samples

Content type
application/json
{
  • "auto_shut_off": true,
  • "pressure_tests_enabled": true,
  • "pressure_tests_schedule": "03:00:00",
  • "timezone": "Europe/London",
  • "webhook_enabled": true,
  • "webhook_url": "https://api.acme.com/webhooks"
}

Modify property settings

Authorizations:
BearerAuth
path Parameters
property_id
required
string

Property UUID

Request Body schema: application/json
optional

Body

auto_shut_off
boolean

Automatic shut off

pressure_tests_enabled
boolean

Enable or disable the pressure test

pressure_tests_schedule
string

The time of day when the pressure test runs, formatted as HH:MM:SS in a 24-hour clock. in 24h clock.

timezone
string

The time zone of the property.

webhook_enabled
boolean

Enable or disable the webhook

webhook_url
string

Webhook url

Responses

Request samples

Content type
application/json
{
  • "auto_shut_off": true,
  • "pressure_tests_enabled": true,
  • "pressure_tests_schedule": "03:00:00",
  • "timezone": "Europe/London",
  • "webhook_enabled": true,
  • "webhook_url": "https://api.acme.com/webhooks"
}

Response samples

Content type
application/json
{
  • "auto_shut_off": true,
  • "pressure_tests_enabled": true,
  • "pressure_tests_schedule": "03:00:00",
  • "timezone": "Europe/London",
  • "webhook_enabled": true,
  • "webhook_url": "https://api.acme.com/webhooks"
}

Retrieve all Signals for property

Authorizations:
BearerAuth
path Parameters
property_id
required
string

Property UUID

query Parameters
page
integer

Page number that is used for the pagination.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page_number": 1,
  • "page_size": 10,
  • "total_entries": 10,
  • "total_pages": 2
}

Property settings

Get property notification settings

Authorizations:
BearerAuth
path Parameters
property_id
required
string

Property UUID

Responses

Response samples

Content type
application/json
{
  • "battery_too_low_to_move_handle": true,
  • "cloud_disconnection": true,
  • "device_handle_moved": true,
  • "health_check_failed": true,
  • "high_humidity": true,
  • "high_humidity_threshold": true,
  • "high_temperature": true,
  • "high_temperature_threshold": true,
  • "high_volume_threshold_litres": 200,
  • "legionella_risk": true,
  • "long_flow_notification_delay_mins": 60,
  • "low_battery_level": true,
  • "low_temperature": true,
  • "low_temperature_threshold": true,
  • "low_water_temperature": true,
  • "pressure_test_failed": true,
  • "pressure_test_skipped": true,
  • "radio_disconnection": true,
  • "water_presence_detected": true
}

Modify property notification settings

Authorizations:
BearerAuth
path Parameters
property_id
required
string

Property UUID

Request Body schema: application/json
optional

Body

battery_too_low_to_move_handle
boolean

Handle couldn't be moved due to low battery notification

cloud_disconnection
boolean

Cloud disconnection notification (e.g. internet failure)

device_handle_moved
boolean

Handle moved notification (e.g. manually closing the valve)

health_check_failed
boolean

Health check failed notification

high_humidity
boolean

High humidity notification

high_humidity_threshold
boolean

High humidity notification threshold

high_temperature
boolean

High temperature notification

high_temperature_threshold
boolean

High temperature notification threshold

high_volume_threshold_litres
integer

Send a notification when we identify water is constantly running and the volume is more than X liters.

legionella_risk
boolean

Legionella stagnation and temperature checks will made every day if true

long_flow_notification_delay_mins
integer

Send a notification when we identify water is constantly running for over than X mins.

low_battery_level
boolean

Low battery notification

low_temperature
boolean

Low temperature notification

low_temperature_threshold
boolean

Low temperature notification threshold

low_water_temperature
boolean

Low water temperature notification

pressure_test_failed
boolean

Pressure test failed notification

pressure_test_skipped
boolean

Pressure test skipped notification

radio_disconnection
boolean

Radio disconnection notification (e.g. Sonic cannot connect to Bridge)

water_presence_detected
boolean

Water presence detected notification

Responses

Request samples

Content type
application/json
{
  • "battery_too_low_to_move_handle": true,
  • "cloud_disconnection": true,
  • "device_handle_moved": true,
  • "health_check_failed": true,
  • "high_humidity": true,
  • "high_humidity_threshold": true,
  • "high_temperature": true,
  • "high_temperature_threshold": true,
  • "high_volume_threshold_litres": 200,
  • "legionella_risk": true,
  • "long_flow_notification_delay_mins": 60,
  • "low_battery_level": true,
  • "low_temperature": true,
  • "low_temperature_threshold": true,
  • "low_water_temperature": true,
  • "pressure_test_failed": true,
  • "pressure_test_skipped": true,
  • "radio_disconnection": true,
  • "water_presence_detected": true
}

Response samples

Content type
application/json
{
  • "battery_too_low_to_move_handle": true,
  • "cloud_disconnection": true,
  • "device_handle_moved": true,
  • "health_check_failed": true,
  • "high_humidity": true,
  • "high_humidity_threshold": true,
  • "high_temperature": true,
  • "high_temperature_threshold": true,
  • "high_volume_threshold_litres": 200,
  • "legionella_risk": true,
  • "long_flow_notification_delay_mins": 60,
  • "low_battery_level": true,
  • "low_temperature": true,
  • "low_temperature_threshold": true,
  • "low_water_temperature": true,
  • "pressure_test_failed": true,
  • "pressure_test_skipped": true,
  • "radio_disconnection": true,
  • "water_presence_detected": true
}

Get property settings

Authorizations:
BearerAuth
path Parameters
property_id
required
string

Property UUID

Responses

Response samples

Content type
application/json
{
  • "auto_shut_off": true,
  • "pressure_tests_enabled": true,
  • "pressure_tests_schedule": "03:00:00",
  • "timezone": "Europe/London",
  • "webhook_enabled": true,
  • "webhook_url": "https://api.acme.com/webhooks"
}

Modify property settings

Authorizations:
BearerAuth
path Parameters
property_id
required
string

Property UUID

Request Body schema: application/json
optional

Body

auto_shut_off
boolean

Automatic shut off

pressure_tests_enabled
boolean

Enable or disable the pressure test

pressure_tests_schedule
string

The time of day when the pressure test runs, formatted as HH:MM:SS in a 24-hour clock. in 24h clock.

timezone
string

The time zone of the property.

webhook_enabled
boolean

Enable or disable the webhook

webhook_url
string

Webhook url

Responses

Request samples

Content type
application/json
{
  • "auto_shut_off": true,
  • "pressure_tests_enabled": true,
  • "pressure_tests_schedule": "03:00:00",
  • "timezone": "Europe/London",
  • "webhook_enabled": true,
  • "webhook_url": "https://api.acme.com/webhooks"
}

Response samples

Content type
application/json
{
  • "auto_shut_off": true,
  • "pressure_tests_enabled": true,
  • "pressure_tests_schedule": "03:00:00",
  • "timezone": "Europe/London",
  • "webhook_enabled": true,
  • "webhook_url": "https://api.acme.com/webhooks"
}

Signals

Retrieve all Signals for property

Authorizations:
BearerAuth
path Parameters
property_id
required
string

Property UUID

query Parameters
page
integer

Page number that is used for the pagination.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page_number": 1,
  • "page_size": 10,
  • "total_entries": 10,
  • "total_pages": 2
}

Retrieve all accessible Signals

Authorizations:
BearerAuth
query Parameters
name
string

Signal name

page
integer

Page number that is used for the pagination.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page_number": 1,
  • "page_size": 10,
  • "total_entries": 10,
  • "total_pages": 2
}

Get Signal

Authorizations:
BearerAuth
path Parameters
id
required
string

Signal UUID

Responses

Response samples

Content type
application/json
{
  • "boot_time": 1622972033,
  • "cloud_connection": "connected",
  • "created_at": "2022-01-22T10:20:30.000Z",
  • "id": "7bcb5fe0-a28a-25e7-93c5-6e6a71c123d2",
  • "modem_boot_time": 1623526880,
  • "modem_version": "1.2.535-84ea330",
  • "name": "This is my Signal name",
  • "serial_no": "fd3c164c13b2d20e",
  • "version": "1.2.547-c8efc17",
  • "wifi_rssi": -69
}

Modify Signal

Authorizations:
BearerAuth
path Parameters
id
required
string

Signal UUID

Request Body schema: application/json
optional

Body

name
string

Signal name

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "boot_time": 1622972033,
  • "cloud_connection": "connected",
  • "created_at": "2022-01-22T10:20:30.000Z",
  • "id": "7bcb5fe0-a28a-25e7-93c5-6e6a71c123d2",
  • "modem_boot_time": 1623526880,
  • "modem_version": "1.2.535-84ea330",
  • "name": "This is my Signal name",
  • "serial_no": "fd3c164c13b2d20e",
  • "version": "1.2.547-c8efc17",
  • "wifi_rssi": -69
}

Modify Signal

Authorizations:
BearerAuth
path Parameters
id
required
string

Signal UUID

Request Body schema: application/json
optional

Body

name
string

Signal name

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "boot_time": 1622972033,
  • "cloud_connection": "connected",
  • "created_at": "2022-01-22T10:20:30.000Z",
  • "id": "7bcb5fe0-a28a-25e7-93c5-6e6a71c123d2",
  • "modem_boot_time": 1623526880,
  • "modem_version": "1.2.535-84ea330",
  • "name": "This is my Signal name",
  • "serial_no": "fd3c164c13b2d20e",
  • "version": "1.2.547-c8efc17",
  • "wifi_rssi": -69
}

Retrieve all Sonics for a Signal

Authorizations:
BearerAuth
path Parameters
signal_id
required
string

Signal UUID

query Parameters
page
integer

Page number that is used for the pagination.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page_number": 1,
  • "page_size": 10,
  • "total_entries": 10,
  • "total_pages": 2
}

Sonics

Retrieve all Sonics for a Signal

Authorizations:
BearerAuth
path Parameters
signal_id
required
string

Signal UUID

query Parameters
page
integer

Page number that is used for the pagination.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page_number": 1,
  • "page_size": 10,
  • "total_entries": 10,
  • "total_pages": 2
}

Retrieve all accessible Sonics

Authorizations:
BearerAuth
query Parameters
name
string

Sonic name

page
integer

Page number that is used for the pagination.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page_number": 1,
  • "page_size": 10,
  • "total_entries": 10,
  • "total_pages": 2
}

Get Sonic

Authorizations:
BearerAuth
path Parameters
id
required
string

Sonic UUID

Responses

Response samples

Content type
application/json
{
  • "battery": "external_power_supply",
  • "created_at": "2022-01-22T10:20:30.000Z",
  • "id": "39bdc4af-a1b8-47d4-8342-82d311e5538e",
  • "name": "This is my Sonic name",
  • "radio_connection": "connected",
  • "radio_rssi": 166,
  • "serial_no": "20fa74b6bffabc12",
  • "signal_id": "39bdc4af-a1b8-47d4-8342-82d311e1234e",
  • "status": "active",
  • "valve_state": "open"
}

Modify Sonic

Authorizations:
BearerAuth
path Parameters
id
required
string

Sonic UUID

Request Body schema: application/json
optional

Body

name
string

Sonic name

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "battery": "external_power_supply",
  • "created_at": "2022-01-22T10:20:30.000Z",
  • "id": "39bdc4af-a1b8-47d4-8342-82d311e5538e",
  • "name": "This is my Sonic name",
  • "radio_connection": "connected",
  • "radio_rssi": 166,
  • "serial_no": "20fa74b6bffabc12",
  • "signal_id": "39bdc4af-a1b8-47d4-8342-82d311e1234e",
  • "status": "active",
  • "valve_state": "open"
}

Modify Sonic

Authorizations:
BearerAuth
path Parameters
id
required
string

Sonic UUID

Request Body schema: application/json
optional

Body

name
string

Sonic name

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "battery": "external_power_supply",
  • "created_at": "2022-01-22T10:20:30.000Z",
  • "id": "39bdc4af-a1b8-47d4-8342-82d311e5538e",
  • "name": "This is my Sonic name",
  • "radio_connection": "connected",
  • "radio_rssi": 166,
  • "serial_no": "20fa74b6bffabc12",
  • "signal_id": "39bdc4af-a1b8-47d4-8342-82d311e1234e",
  • "status": "active",
  • "valve_state": "open"
}

Telemetry details

Get the latest telemetry details

Authorizations:
BearerAuth
path Parameters
sonic_id
required
string

Sonic UUID

Responses

Response samples

Content type
application/json
{
  • "pressure": 3252,
  • "probed_at": 1623414482,
  • "water_flow": 0,
  • "water_temp": 17.1
}

Valve control

Control the Sonic valve (open or close)

Authorizations:
BearerAuth
path Parameters
sonic_id
required
string

Sonic UUID

Request Body schema: application/json
optional

Body

action
required
string
Enum: "open" "close"

Action for opening or closing the valve.

Responses

Request samples

Content type
application/json
{
  • "action": "open"
}