curl --request PUT \
--url https://api.orbital-systems.com/client/taps/{id}/configuration \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"active_timeout_s": 120,
"default_flow": 2,
"default_temp": 36,
"min_flow": 1,
"min_temp": 1,
"max_flow": 12,
"max_temp": 44,
"shower": false,
"theme": 0,
"time_zone_name": "Europe/Stockholm",
"units": 0,
"wall_clock_12_hour_format": false,
"wall_clock_enabled": false,
"welcome_message_enabled": false,
"welcome_message": "Welcome!"
}
'import requests
url = "https://api.orbital-systems.com/client/taps/{id}/configuration"
payload = {
"active_timeout_s": 120,
"default_flow": 2,
"default_temp": 36,
"min_flow": 1,
"min_temp": 1,
"max_flow": 12,
"max_temp": 44,
"shower": False,
"theme": 0,
"time_zone_name": "Europe/Stockholm",
"units": 0,
"wall_clock_12_hour_format": False,
"wall_clock_enabled": False,
"welcome_message_enabled": False,
"welcome_message": "Welcome!"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
active_timeout_s: 120,
default_flow: 2,
default_temp: 36,
min_flow: 1,
min_temp: 1,
max_flow: 12,
max_temp: 44,
shower: false,
theme: 0,
time_zone_name: 'Europe/Stockholm',
units: 0,
wall_clock_12_hour_format: false,
wall_clock_enabled: false,
welcome_message_enabled: false,
welcome_message: 'Welcome!'
})
};
fetch('https://api.orbital-systems.com/client/taps/{id}/configuration', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbital-systems.com/client/taps/{id}/configuration",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'active_timeout_s' => 120,
'default_flow' => 2,
'default_temp' => 36,
'min_flow' => 1,
'min_temp' => 1,
'max_flow' => 12,
'max_temp' => 44,
'shower' => false,
'theme' => 0,
'time_zone_name' => 'Europe/Stockholm',
'units' => 0,
'wall_clock_12_hour_format' => false,
'wall_clock_enabled' => false,
'welcome_message_enabled' => false,
'welcome_message' => 'Welcome!'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbital-systems.com/client/taps/{id}/configuration"
payload := strings.NewReader("{\n \"active_timeout_s\": 120,\n \"default_flow\": 2,\n \"default_temp\": 36,\n \"min_flow\": 1,\n \"min_temp\": 1,\n \"max_flow\": 12,\n \"max_temp\": 44,\n \"shower\": false,\n \"theme\": 0,\n \"time_zone_name\": \"Europe/Stockholm\",\n \"units\": 0,\n \"wall_clock_12_hour_format\": false,\n \"wall_clock_enabled\": false,\n \"welcome_message_enabled\": false,\n \"welcome_message\": \"Welcome!\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.orbital-systems.com/client/taps/{id}/configuration")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"active_timeout_s\": 120,\n \"default_flow\": 2,\n \"default_temp\": 36,\n \"min_flow\": 1,\n \"min_temp\": 1,\n \"max_flow\": 12,\n \"max_temp\": 44,\n \"shower\": false,\n \"theme\": 0,\n \"time_zone_name\": \"Europe/Stockholm\",\n \"units\": 0,\n \"wall_clock_12_hour_format\": false,\n \"wall_clock_enabled\": false,\n \"welcome_message_enabled\": false,\n \"welcome_message\": \"Welcome!\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbital-systems.com/client/taps/{id}/configuration")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"active_timeout_s\": 120,\n \"default_flow\": 2,\n \"default_temp\": 36,\n \"min_flow\": 1,\n \"min_temp\": 1,\n \"max_flow\": 12,\n \"max_temp\": 44,\n \"shower\": false,\n \"theme\": 0,\n \"time_zone_name\": \"Europe/Stockholm\",\n \"units\": 0,\n \"wall_clock_12_hour_format\": false,\n \"wall_clock_enabled\": false,\n \"welcome_message_enabled\": false,\n \"welcome_message\": \"Welcome!\"\n}"
response = http.request(request)
puts response.read_body{
"active_timeout_s": 120,
"default_flow": 2,
"default_temp": 36,
"min_flow": 1,
"min_temp": 1,
"max_flow": 12,
"max_temp": 44,
"shower": false,
"theme": 0,
"time_zone_name": "Europe/Stockholm",
"units": 0,
"wall_clock_12_hour_format": false,
"wall_clock_enabled": false,
"welcome_message_enabled": false,
"welcome_message": "Welcome!"
}{
"message": "Unauthorized",
"statusCode": 401,
"name": "UnauthorizedError"
}{
"message": "Tap not found",
"statusCode": 404,
"name": "NotFoundError"
}{
"message": "Internal server error"
}Update configuration
curl --request PUT \
--url https://api.orbital-systems.com/client/taps/{id}/configuration \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"active_timeout_s": 120,
"default_flow": 2,
"default_temp": 36,
"min_flow": 1,
"min_temp": 1,
"max_flow": 12,
"max_temp": 44,
"shower": false,
"theme": 0,
"time_zone_name": "Europe/Stockholm",
"units": 0,
"wall_clock_12_hour_format": false,
"wall_clock_enabled": false,
"welcome_message_enabled": false,
"welcome_message": "Welcome!"
}
'import requests
url = "https://api.orbital-systems.com/client/taps/{id}/configuration"
payload = {
"active_timeout_s": 120,
"default_flow": 2,
"default_temp": 36,
"min_flow": 1,
"min_temp": 1,
"max_flow": 12,
"max_temp": 44,
"shower": False,
"theme": 0,
"time_zone_name": "Europe/Stockholm",
"units": 0,
"wall_clock_12_hour_format": False,
"wall_clock_enabled": False,
"welcome_message_enabled": False,
"welcome_message": "Welcome!"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
active_timeout_s: 120,
default_flow: 2,
default_temp: 36,
min_flow: 1,
min_temp: 1,
max_flow: 12,
max_temp: 44,
shower: false,
theme: 0,
time_zone_name: 'Europe/Stockholm',
units: 0,
wall_clock_12_hour_format: false,
wall_clock_enabled: false,
welcome_message_enabled: false,
welcome_message: 'Welcome!'
})
};
fetch('https://api.orbital-systems.com/client/taps/{id}/configuration', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbital-systems.com/client/taps/{id}/configuration",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'active_timeout_s' => 120,
'default_flow' => 2,
'default_temp' => 36,
'min_flow' => 1,
'min_temp' => 1,
'max_flow' => 12,
'max_temp' => 44,
'shower' => false,
'theme' => 0,
'time_zone_name' => 'Europe/Stockholm',
'units' => 0,
'wall_clock_12_hour_format' => false,
'wall_clock_enabled' => false,
'welcome_message_enabled' => false,
'welcome_message' => 'Welcome!'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbital-systems.com/client/taps/{id}/configuration"
payload := strings.NewReader("{\n \"active_timeout_s\": 120,\n \"default_flow\": 2,\n \"default_temp\": 36,\n \"min_flow\": 1,\n \"min_temp\": 1,\n \"max_flow\": 12,\n \"max_temp\": 44,\n \"shower\": false,\n \"theme\": 0,\n \"time_zone_name\": \"Europe/Stockholm\",\n \"units\": 0,\n \"wall_clock_12_hour_format\": false,\n \"wall_clock_enabled\": false,\n \"welcome_message_enabled\": false,\n \"welcome_message\": \"Welcome!\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.orbital-systems.com/client/taps/{id}/configuration")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"active_timeout_s\": 120,\n \"default_flow\": 2,\n \"default_temp\": 36,\n \"min_flow\": 1,\n \"min_temp\": 1,\n \"max_flow\": 12,\n \"max_temp\": 44,\n \"shower\": false,\n \"theme\": 0,\n \"time_zone_name\": \"Europe/Stockholm\",\n \"units\": 0,\n \"wall_clock_12_hour_format\": false,\n \"wall_clock_enabled\": false,\n \"welcome_message_enabled\": false,\n \"welcome_message\": \"Welcome!\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbital-systems.com/client/taps/{id}/configuration")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"active_timeout_s\": 120,\n \"default_flow\": 2,\n \"default_temp\": 36,\n \"min_flow\": 1,\n \"min_temp\": 1,\n \"max_flow\": 12,\n \"max_temp\": 44,\n \"shower\": false,\n \"theme\": 0,\n \"time_zone_name\": \"Europe/Stockholm\",\n \"units\": 0,\n \"wall_clock_12_hour_format\": false,\n \"wall_clock_enabled\": false,\n \"welcome_message_enabled\": false,\n \"welcome_message\": \"Welcome!\"\n}"
response = http.request(request)
puts response.read_body{
"active_timeout_s": 120,
"default_flow": 2,
"default_temp": 36,
"min_flow": 1,
"min_temp": 1,
"max_flow": 12,
"max_temp": 44,
"shower": false,
"theme": 0,
"time_zone_name": "Europe/Stockholm",
"units": 0,
"wall_clock_12_hour_format": false,
"wall_clock_enabled": false,
"welcome_message_enabled": false,
"welcome_message": "Welcome!"
}{
"message": "Unauthorized",
"statusCode": 401,
"name": "UnauthorizedError"
}{
"message": "Tap not found",
"statusCode": 404,
"name": "NotFoundError"
}{
"message": "Internal server error"
}Authorizations
Send your API key in the x-api-key header of every request. The key belongs to one Orbital account, and requests act as that account: they see and control only the devices it owns or has been given access to. A missing or unknown key gets 403 with { "message": "Forbidden" }.
Path Parameters
The unique identifier for the tap
Body
Seconds the tap stays on after it is turned on.
120
Flow the tap starts at, in L/min.
2
Temperature the tap starts at, in °C.
36
Lowest flow a user can set, in L/min.
1
Lowest temperature a user can set, in °C.
1
Highest flow a user can set, in L/min.
12
Highest temperature a user can set, in °C.
44
Switches the Control dial to a shower interface, for a tap that runs a shower.
false
Control dial theme: 0 light, 1 dark.
0 <= x <= 10
IANA time zone of the tap, used for its clock.
"Europe/Stockholm"
Units shown on the Control dial: 0 metric (L/min, °C), 1 imperial (gpm, °F). The API always uses metric.
0 <= x <= 10
Shows the Control dial clock in 12-hour (AM/PM) format.
false
Shows a clock on the Control dial.
false
Shows a welcome message when the tap is turned on.
false
Text of the welcome message, under 36 bytes in UTF-8.
"Welcome!"
Response
Configuration updated successfully
Seconds the tap stays on after it is turned on.
120
Flow the tap starts at, in L/min.
2
Temperature the tap starts at, in °C.
36
Lowest flow a user can set, in L/min.
1
Lowest temperature a user can set, in °C.
1
Highest flow a user can set, in L/min.
12
Highest temperature a user can set, in °C.
44
Switches the Control dial to a shower interface, for a tap that runs a shower.
false
Control dial theme: 0 light, 1 dark.
0
IANA time zone of the tap, used for its clock.
"Europe/Stockholm"
Units shown on the Control dial: 0 metric (L/min, °C), 1 imperial (gpm, °F). The API always uses metric.
0
Shows the Control dial clock in 12-hour (AM/PM) format.
false
Shows a clock on the Control dial.
false
Shows a welcome message when the tap is turned on.
false
Text of the welcome message, under 36 bytes in UTF-8.
"Welcome!"
Was this page helpful?