List relays
curl --request GET \
--url http://localhost:8080/api/v1/relays \
--cookie __Host-oc_session=import requests
url = "http://localhost:8080/api/v1/relays"
headers = {"cookie": "__Host-oc_session="}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {cookie: '__Host-oc_session='}};
fetch('http://localhost:8080/api/v1/relays', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/relays",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_COOKIE => "__Host-oc_session=",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/relays"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("cookie", "__Host-oc_session=")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/relays")
.header("cookie", "__Host-oc_session=")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/relays")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["cookie"] = '__Host-oc_session='
response = http.request(request)
puts response.read_body{
"next": "<string>",
"total": 1,
"items": [
{
"registrationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clusterFingerprint": "<string>",
"relayVersion": "<string>",
"compatibility": "compatible",
"registeredAt": "2023-11-07T05:31:56Z",
"connected": true,
"capabilities": [
"<string>"
],
"revokedAt": "2023-11-07T05:31:56Z",
"lastSeenAt": "2023-11-07T05:31:56Z",
"sessionConflict": {
"detectedAt": "2023-11-07T05:31:56Z",
"distinctHosts": 3,
"multipleHosts": true
}
}
]
}{
"error": "the requested resource is not available to this caller",
"reason": "credential_rejected",
"requires": "<string>"
}Relays
List relays
GET
/
api
/
v1
/
relays
List relays
curl --request GET \
--url http://localhost:8080/api/v1/relays \
--cookie __Host-oc_session=import requests
url = "http://localhost:8080/api/v1/relays"
headers = {"cookie": "__Host-oc_session="}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {cookie: '__Host-oc_session='}};
fetch('http://localhost:8080/api/v1/relays', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/relays",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_COOKIE => "__Host-oc_session=",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/relays"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("cookie", "__Host-oc_session=")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/relays")
.header("cookie", "__Host-oc_session=")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/relays")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["cookie"] = '__Host-oc_session='
response = http.request(request)
puts response.read_body{
"next": "<string>",
"total": 1,
"items": [
{
"registrationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clusterFingerprint": "<string>",
"relayVersion": "<string>",
"compatibility": "compatible",
"registeredAt": "2023-11-07T05:31:56Z",
"connected": true,
"capabilities": [
"<string>"
],
"revokedAt": "2023-11-07T05:31:56Z",
"lastSeenAt": "2023-11-07T05:31:56Z",
"sessionConflict": {
"detectedAt": "2023-11-07T05:31:56Z",
"distinctHosts": 3,
"multipleHosts": true
}
}
]
}{
"error": "the requested resource is not available to this caller",
"reason": "credential_rejected",
"requires": "<string>"
}Authorizations
Query Parameters
Opaque resume position returned in the preceding page's next field.
Required string length:
1 - 512Required range:
1 <= x <= 200Case-insensitive containment search over the Relay identifier, fingerprint, and version.
Required string length:
1 - 256Available options:
registeredAt, -registeredAt, lastSeenAt, -lastSeenAt, version, -version, fingerprint, -fingerprint Available options:
connected, disconnected, revoked, degraded Exact Relay version without surrounding whitespace.
Required string length:
1 - 128Pattern:
^\S(?:.*\S)?$Exact capability identifier without surrounding whitespace.
Required string length:
1 - 128Pattern:
^\S(?:.*\S)?$