Read public API health

GET/v1/healthRead public API health

Returns the current public health status. No authentication is required. A successful response confirms this endpoint is responding; it is not a guarantee that every dependent service is healthy.

Responses

object

statusstringrequired

one of "ok"

Example response

{
  "status": "ok"
}

Examples

curl -X GET '{{SERVER_NOT_CONFIGURED}}/v1/health'

const response = await fetch('{{SERVER_NOT_CONFIGURED}}/v1/health', { method: 'GET' });
const data = await response.json();

const response = await fetch('{{SERVER_NOT_CONFIGURED}}/v1/health', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "{{SERVER_NOT_CONFIGURED}}/v1/health")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "{{SERVER_NOT_CONFIGURED}}/v1/health", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("{{SERVER_NOT_CONFIGURED}}/v1/health");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("{{SERVER_NOT_CONFIGURED}}/v1/health"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("{{SERVER_NOT_CONFIGURED}}/v1/health")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "{{SERVER_NOT_CONFIGURED}}/v1/health");
using var response = await client.SendAsync(request);

{
  "status": "ok"
}

Search documentation

Operations

Read public API health

Responses

Operations