EQTY LabDocs

Get service health

Returns the health status, service name, timestamp, deployed version, and uptime of the Integrity Service. It needs no authentication.

gethttps://<host>/health/v1
bash
curl --request GET \
  --url 'https://<host>/health/v1'
javascript
const response = await fetch("https://<host>/health/v1", {
  method: "GET"
});

const data = await response.json();
typescript
interface HealthResponse {
  service: string;
  status: string;
  timestamp: string;
  uptime_seconds: number;
  version: string;
}

const response = await fetch("https://<host>/health/v1", {
  method: "GET"
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: HealthResponse = await response.json();
python
import requests

response = requests.get(
    "https://<host>/health/v1",
)
response.raise_for_status()
print(response.json())
go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://<host>/health/v1", nil)
	if err != nil {
		panic(err)
	}

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://<host>/health/v1"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
csharp
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://<host>/health/v1");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://<host>/health/v1');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;
ruby
require "net/http"

uri = URI("https://<host>/health/v1")
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"
rust
// Cargo.toml dependencies: reqwest, tokio (features "full")

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .get("https://<host>/health/v1")
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Responses

200Service is healthy

application/json
  • servicestringrequired
  • statusstringrequired
  • timestampstring<date-time>required
  • uptime_secondsinteger<int64>required
  • versionstringrequired
Examplejson
{
  "service": "string",
  "status": "string",
  "timestamp": "2025-03-12T12:00:06Z",
  "uptime_seconds": 0,
  "version": "string"
}