Relay Placement Heartbeat
curl --request PUT \
--url https://api.qumo-deploy.com/v1/relays/{relay_id} \
--header 'Content-Type: application/json' \
--data '
{
"region": "is1a",
"host": "is1a-1.relay.qumo-deploy.com",
"port": 4433
}
'import requests
url = "https://api.qumo-deploy.com/v1/relays/{relay_id}"
payload = {
"region": "is1a",
"host": "is1a-1.relay.qumo-deploy.com",
"port": 4433
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({region: 'is1a', host: 'is1a-1.relay.qumo-deploy.com', port: 4433})
};
fetch('https://api.qumo-deploy.com/v1/relays/{relay_id}', 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.qumo-deploy.com/v1/relays/{relay_id}",
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([
'region' => 'is1a',
'host' => 'is1a-1.relay.qumo-deploy.com',
'port' => 4433
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.qumo-deploy.com/v1/relays/{relay_id}"
payload := strings.NewReader("{\n \"region\": \"is1a\",\n \"host\": \"is1a-1.relay.qumo-deploy.com\",\n \"port\": 4433\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.qumo-deploy.com/v1/relays/{relay_id}")
.header("Content-Type", "application/json")
.body("{\n \"region\": \"is1a\",\n \"host\": \"is1a-1.relay.qumo-deploy.com\",\n \"port\": 4433\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qumo-deploy.com/v1/relays/{relay_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"region\": \"is1a\",\n \"host\": \"is1a-1.relay.qumo-deploy.com\",\n \"port\": 4433\n}"
response = http.request(request)
puts response.read_bodyAPI Reference
Relay Placement Heartbeat
Internal relay-mesh endpoint, authenticated like introspection. A relay reports that it is alive and how clients reach it; relays that stop reporting leave placement after 45 s. Mounted only when the server has a relay domain (RELAY_PUBLIC_DOMAIN), and the host must lie under it.
PUT
/
v1
/
relays
/
{relay_id}
Relay Placement Heartbeat
curl --request PUT \
--url https://api.qumo-deploy.com/v1/relays/{relay_id} \
--header 'Content-Type: application/json' \
--data '
{
"region": "is1a",
"host": "is1a-1.relay.qumo-deploy.com",
"port": 4433
}
'import requests
url = "https://api.qumo-deploy.com/v1/relays/{relay_id}"
payload = {
"region": "is1a",
"host": "is1a-1.relay.qumo-deploy.com",
"port": 4433
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({region: 'is1a', host: 'is1a-1.relay.qumo-deploy.com', port: 4433})
};
fetch('https://api.qumo-deploy.com/v1/relays/{relay_id}', 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.qumo-deploy.com/v1/relays/{relay_id}",
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([
'region' => 'is1a',
'host' => 'is1a-1.relay.qumo-deploy.com',
'port' => 4433
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.qumo-deploy.com/v1/relays/{relay_id}"
payload := strings.NewReader("{\n \"region\": \"is1a\",\n \"host\": \"is1a-1.relay.qumo-deploy.com\",\n \"port\": 4433\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.qumo-deploy.com/v1/relays/{relay_id}")
.header("Content-Type", "application/json")
.body("{\n \"region\": \"is1a\",\n \"host\": \"is1a-1.relay.qumo-deploy.com\",\n \"port\": 4433\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qumo-deploy.com/v1/relays/{relay_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"region\": \"is1a\",\n \"host\": \"is1a-1.relay.qumo-deploy.com\",\n \"port\": 4433\n}"
response = http.request(request)
puts response.read_bodyPath Parameters
Pattern:
^[a-z0-9][a-z0-9-]{0,62}$Body
application/json
Response
Recorded