API reference
Get an endpoint
Fetch a single endpoint owned by the calling team. An endpoint owned by another team or one that has been deleted returns 404, indistinguishable from one that never existed. options holds the IP allowlist, origin allowlist and log retention; an empty list means that allowlist is off, and log_retention_hours 0 means request logs are off.
GET
/
endpoints
/
{id}
Get an endpoint
curl --request GET \
--url https://api.validationcloud.io/admin/v1/endpoints/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.validationcloud.io/admin/v1/endpoints/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.validationcloud.io/admin/v1/endpoints/{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.validationcloud.io/admin/v1/endpoints/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://api.validationcloud.io/admin/v1/endpoints/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.validationcloud.io/admin/v1/endpoints/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.validationcloud.io/admin/v1/endpoints/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"api_key": "<string>",
"chain": "<string>",
"enabled": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"network": "<string>",
"options": {
"allowed_ips": [
"<string>"
],
"allowed_origins": [
"<string>"
],
"log_retention_hours": 123
},
"urls": {
"https": "<string>",
"wss": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "from must be an RFC3339 timestamp"
}
}{
"error": {
"code": "invalid_request",
"message": "from must be an RFC3339 timestamp"
}
}{
"error": {
"code": "invalid_request",
"message": "from must be an RFC3339 timestamp"
}
}{
"error": {
"code": "invalid_request",
"message": "from must be an RFC3339 timestamp"
}
}Authorizations
Admin API key under the ApiKey scheme: Authorization: ApiKey vc_adm_.... Each key is bound to one team and carries a READ or WRITE scope; the usage endpoints require only READ.
Path Parameters
Endpoint UUID
Get an endpoint
curl --request GET \
--url https://api.validationcloud.io/admin/v1/endpoints/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.validationcloud.io/admin/v1/endpoints/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.validationcloud.io/admin/v1/endpoints/{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.validationcloud.io/admin/v1/endpoints/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://api.validationcloud.io/admin/v1/endpoints/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.validationcloud.io/admin/v1/endpoints/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.validationcloud.io/admin/v1/endpoints/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"api_key": "<string>",
"chain": "<string>",
"enabled": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"network": "<string>",
"options": {
"allowed_ips": [
"<string>"
],
"allowed_origins": [
"<string>"
],
"log_retention_hours": 123
},
"urls": {
"https": "<string>",
"wss": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "from must be an RFC3339 timestamp"
}
}{
"error": {
"code": "invalid_request",
"message": "from must be an RFC3339 timestamp"
}
}{
"error": {
"code": "invalid_request",
"message": "from must be an RFC3339 timestamp"
}
}{
"error": {
"code": "invalid_request",
"message": "from must be an RFC3339 timestamp"
}
}