Sidecar Configuration
curl --request GET \
--url https://use.hoop.dev/api/sidecars/configuration \
--header 'hoop-sidecar-token: <hoop-sidecar-token>'import requests
url = "https://use.hoop.dev/api/sidecars/configuration"
headers = {"hoop-sidecar-token": "<hoop-sidecar-token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'hoop-sidecar-token': '<hoop-sidecar-token>'}};
fetch('https://use.hoop.dev/api/sidecars/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://use.hoop.dev/api/sidecars/configuration",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"hoop-sidecar-token: <hoop-sidecar-token>"
],
]);
$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 := "https://use.hoop.dev/api/sidecars/configuration"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("hoop-sidecar-token", "<hoop-sidecar-token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://use.hoop.dev/api/sidecars/configuration")
.header("hoop-sidecar-token", "<hoop-sidecar-token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/sidecars/configuration")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["hoop-sidecar-token"] = '<hoop-sidecar-token>'
response = http.request(request)
puts response.read_body{}{
"message": "the error description"
}{
"message": "the error description"
}Sidecars
Sidecar Configuration
Authenticated with the hoop-sidecar-token header. Returns the configuration the sidecar must serve. Unlike the handshake it records nothing, so a poll never overwrites what the sidecar last reported about itself.
GET
/
sidecars
/
configuration
Sidecar Configuration
curl --request GET \
--url https://use.hoop.dev/api/sidecars/configuration \
--header 'hoop-sidecar-token: <hoop-sidecar-token>'import requests
url = "https://use.hoop.dev/api/sidecars/configuration"
headers = {"hoop-sidecar-token": "<hoop-sidecar-token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'hoop-sidecar-token': '<hoop-sidecar-token>'}};
fetch('https://use.hoop.dev/api/sidecars/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://use.hoop.dev/api/sidecars/configuration",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"hoop-sidecar-token: <hoop-sidecar-token>"
],
]);
$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 := "https://use.hoop.dev/api/sidecars/configuration"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("hoop-sidecar-token", "<hoop-sidecar-token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://use.hoop.dev/api/sidecars/configuration")
.header("hoop-sidecar-token", "<hoop-sidecar-token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/sidecars/configuration")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["hoop-sidecar-token"] = '<hoop-sidecar-token>'
response = http.request(request)
puts response.read_body{}{
"message": "the error description"
}{
"message": "the error description"
}Headers
The token returned when the sidecar was created
Response
OK
The response is of type object.
Was this page helpful?