Skip to main content
PUT
/
client
/
taps
/
{id}
/
configuration
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": 123,
  "default_flow": 123,
  "default_temp": 123,
  "min_flow": 123,
  "min_temp": 123,
  "max_flow": 123,
  "max_temp": 123,
  "theme": 0.5,
  "time_zone": "<string>",
  "time_zone_name": "<string>",
  "units": 0.5,
  "wall_clock_enabled": true,
  "welcome_message_enabled": true,
  "welcome_message": "<string>"
}
'
import requests

url = "https://api.orbital-systems.com/client/taps/{id}/configuration"

payload = {
"active_timeout_s": 123,
"default_flow": 123,
"default_temp": 123,
"min_flow": 123,
"min_temp": 123,
"max_flow": 123,
"max_temp": 123,
"theme": 0.5,
"time_zone": "<string>",
"time_zone_name": "<string>",
"units": 0.5,
"wall_clock_enabled": True,
"welcome_message_enabled": True,
"welcome_message": "<string>"
}
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: 123,
default_flow: 123,
default_temp: 123,
min_flow: 123,
min_temp: 123,
max_flow: 123,
max_temp: 123,
theme: 0.5,
time_zone: '<string>',
time_zone_name: '<string>',
units: 0.5,
wall_clock_enabled: true,
welcome_message_enabled: true,
welcome_message: '<string>'
})
};

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' => 123,
'default_flow' => 123,
'default_temp' => 123,
'min_flow' => 123,
'min_temp' => 123,
'max_flow' => 123,
'max_temp' => 123,
'theme' => 0.5,
'time_zone' => '<string>',
'time_zone_name' => '<string>',
'units' => 0.5,
'wall_clock_enabled' => true,
'welcome_message_enabled' => true,
'welcome_message' => '<string>'
]),
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\": 123,\n \"default_flow\": 123,\n \"default_temp\": 123,\n \"min_flow\": 123,\n \"min_temp\": 123,\n \"max_flow\": 123,\n \"max_temp\": 123,\n \"theme\": 0.5,\n \"time_zone\": \"<string>\",\n \"time_zone_name\": \"<string>\",\n \"units\": 0.5,\n \"wall_clock_enabled\": true,\n \"welcome_message_enabled\": true,\n \"welcome_message\": \"<string>\"\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\": 123,\n \"default_flow\": 123,\n \"default_temp\": 123,\n \"min_flow\": 123,\n \"min_temp\": 123,\n \"max_flow\": 123,\n \"max_temp\": 123,\n \"theme\": 0.5,\n \"time_zone\": \"<string>\",\n \"time_zone_name\": \"<string>\",\n \"units\": 0.5,\n \"wall_clock_enabled\": true,\n \"welcome_message_enabled\": true,\n \"welcome_message\": \"<string>\"\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\": 123,\n \"default_flow\": 123,\n \"default_temp\": 123,\n \"min_flow\": 123,\n \"min_temp\": 123,\n \"max_flow\": 123,\n \"max_temp\": 123,\n \"theme\": 0.5,\n \"time_zone\": \"<string>\",\n \"time_zone_name\": \"<string>\",\n \"units\": 0.5,\n \"wall_clock_enabled\": true,\n \"welcome_message_enabled\": true,\n \"welcome_message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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 unique identifier for the tap

Body

application/json
active_timeout_s
number
default_flow
number
default_temp
number
min_flow
number
min_temp
number
max_flow
number
max_temp
number
theme
number
Required range: 0 <= x <= 1
time_zone
string
time_zone_name
string
units
number
Required range: 0 <= x <= 1
wall_clock_enabled
boolean
welcome_message_enabled
boolean
welcome_message
string

Response

Configuration updated successfully

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