Get Sidecar
curl --request GET \
--url https://use.hoop.dev/api/sidecars/{nameOrID}import requests
url = "https://use.hoop.dev/api/sidecars/{nameOrID}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://use.hoop.dev/api/sidecars/{nameOrID}', 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/{nameOrID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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/{nameOrID}"
req, _ := http.NewRequest("GET", url, nil)
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/{nameOrID}")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/sidecars/{nameOrID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"connections": [
"pg-prod"
],
"created_at": "<string>",
"created_by": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_seen_at": "<string>",
"name": "payments-sidecar",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "1.0.0"
}{
"message": "the error description"
}{
"message": "the error description"
}Sidecars
Get Sidecar
Get a sidecar by name or ID
GET
/
sidecars
/
{nameOrID}
Get Sidecar
curl --request GET \
--url https://use.hoop.dev/api/sidecars/{nameOrID}import requests
url = "https://use.hoop.dev/api/sidecars/{nameOrID}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://use.hoop.dev/api/sidecars/{nameOrID}', 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/{nameOrID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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/{nameOrID}"
req, _ := http.NewRequest("GET", url, nil)
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/{nameOrID}")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/sidecars/{nameOrID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"connections": [
"pg-prod"
],
"created_at": "<string>",
"created_by": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_seen_at": "<string>",
"name": "payments-sidecar",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "1.0.0"
}{
"message": "the error description"
}{
"message": "the error description"
}Path Parameters
Name or UUID of the sidecar
Response
OK
Names of the connections this sidecar fronts
Example:
["pg-prod"]
Creation timestamp
Subject of the admin who created it
Unique identifier
Last time this gateway process saw the sidecar. Same lifetime as Version.
Human-readable name
Example:
"payments-sidecar"
Organization ID
Version reported at the last handshake. Held in gateway memory, not stored, so it is empty until the sidecar calls and again after a gateway restart.
Example:
"1.0.0"
Was this page helpful?