API Reference

Health check

View Markdown

GET /api/health

Health check

Operation IDgetHealth

Authentication

No authentication is required.

Success response body

200Server is healthy

Server is healthy

Content typeapplication/json

responseobject

4 properties

statusstring

Example: ok

activeRunsinteger

executorModestring

Allowed values: local, http

executorCountinteger

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/health'

const response = await fetch("https://your-envoy.example.com/api/health", {
  method: "GET",
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);