Skip to content

Server Heartbeat

A simple liveness probe that reports whether the API is reachable. Useful for health checks and uptime monitoring.

Scopes

The heartbeat endpoint is unauthenticated — it does not require a token or API key.

Endpoints

Heartbeat

GET /api/heartbeat/

Returns a short status payload confirming the API is responding.

Required scope: none

Response 200Heartbeat

Errors: 5xx only — any non-200 response should be treated as the API being unhealthy.

Example

bash
curl "https://<tenant>.s-launch.com/api/heartbeat/"

S-Launch