Health
curl --request GET \
--url https://api.example.com/v1/healthimport requests
url = "https://api.example.com/v1/health"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/health', 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.example.com/v1/health",
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://api.example.com/v1/health"
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://api.example.com/v1/health")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/health")
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_bodyStatus
Health
Readiness check for load balancers and monitoring.
GET
/
v1
/
health
Health
curl --request GET \
--url https://api.example.com/v1/healthimport requests
url = "https://api.example.com/v1/health"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/health', 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.example.com/v1/health",
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://api.example.com/v1/health"
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://api.example.com/v1/health")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/health")
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_bodyReports whether the gateway is ready to serve. Point your load balancer or uptime monitor here.
Two possible answers:
All fields are snake_case.
200with a ready status, once the gateway has caught up with the chain.503with a bootstrapping status and a progress snapshot, while it’s still replaying history.
503 until the gateway is ready (conventions).
Example
curl -i "$TAPE_GATEWAY/v1/health"
Ready
{ "status": "ready" }
Bootstrapping
{
"status": "bootstrapping",
"bootstrap": {
"phase": "block_replay",
"snapshot_epoch": 412,
"start_slot": 18100000,
"current_slot": 18234500,
"target_slot": 18240010,
"percent_done": 96.1,
"slots_per_sec": 850.0,
"eta_secs": 6,
"skipped_slots": 120
}
}
bootstrap appears only while bootstrapping, and eta_secs is omitted until enough slots have replayed to estimate a rate. phase is one of starting, snapshot_replay, block_replay, ready.