Skip to content

API reference

Check the service

GETapi.aegoralabs.de/health
curl https://api.aegoralabs.de/health --max-time 10

Returns 200 while the service is running. Needs no API key and calls no other service.

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.

200 Successful response

Media typeapplication/json
{
"<key>": string
}
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
>= 1 <= 3600

Seconds until the current window ends. Windows start on every full UTC hour.