API reference
Check the service
curl https://api.aegoralabs.de/health --max-time 10import requests
response = requests.get("https://api.aegoralabs.de/health", timeout=10)print(response.status_code, response.json()["status"])// Node.js 18 or laterconst response = await fetch("https://api.aegoralabs.de/health", { signal: AbortSignal.timeout(10_000),});console.log(response.status, (await response.json()).status);// Java 11 or later. Run with: java Main.javaimport java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.time.Duration;
public class Main { public static void main(String[] args) throws Exception { HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.aegoralabs.de/health")) .timeout(Duration.ofSeconds(10)) .build();
HttpResponse<String> response = HttpClient.newHttpClient() .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body()); }}// .NET 6 or laterusing var client = new HttpClient { Timeout = TimeSpan.FromSeconds(10) };using var response = await client.GetAsync("https://api.aegoralabs.de/health");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");package main
import ( "fmt" "io" "net/http" "time")
func main() { client := &http.Client{Timeout: 10 * time.Second} response, err := client.Get("https://api.aegoralabs.de/health") if err != nil { panic(err) } defer response.Body.Close()
body, err := io.ReadAll(response.Body) if err != nil { panic(err) } fmt.Println(response.StatusCode, string(body))}# Windows PowerShell 5.1 or PowerShell 7$result = Invoke-RestMethod -Uri "https://api.aegoralabs.de/health" -TimeoutSec 10$result.statusReturns 200 while the service is running. Needs no API key and calls no other service.
Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”X-Request-Id
string
Optional. If the whole value matches [A-Za-z0-9._~-]{1,128}, it is echoed in the X-Request-Id response header, in result_id and in instance. Any other value is replaced by a generated UUID4. It never causes an error.
Responses
Section titled “Responses”200 Successful response
Media typeapplication/json
{
"<key>": string
}
{ "status": "ok"}Headers
Section titled “Headers”X-Request-Id
string
The request’s identifier: the caller’s own X-Request-Id if it matched the allowed format, otherwise a generated UUID4. The same value as result_id in a success body and as the identifier inside instance in an error body.
RateLimit-Limit
integer
Requests allowed per window for this key.
RateLimit-Remaining
integer
Requests left in the current window. Equals RateLimit-Limit while nothing is counted.
RateLimit-Reset
integer
Seconds until the current window ends. Windows start on every full UTC hour.