API Reference
Health check
Health check
GET /api/health
Health check
Operation ID: getHealth
Authentication
No authentication is required.
Success responses
200
Server is healthy
Content type: application/json
- Type:
object - Properties:
status(string)- Example:
ok
- Example:
activeRuns(integer)executorMode(string)- Allowed values:
local,http
- Allowed values:
executorCount(integer)
Examples
cURL
curl --request GET \
--url 'https://your-envoy.example.com/api/health'JavaScript (fetch)
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);