Skip to content

Availability

GET /healthcheck

Checks whether the API is reachable.

Access: public.

Request

GET /directlink/v2/healthcheck HTTP/1.1
Host: api.example.com
Accept: application/json

Responses

HTTPMeaning
200Service reachable. Includes Cache-Control: no-store.

Response example — 200 OK

{
  "status": "ok",
  "service": "STCPDirectLink",
  "timestamp": "2026-10-16T19:29:23Z",
  "uptime_seconds": 86400
}
FieldTypeDescription
statusstringAlways ok.
servicestringAlways STCPDirectLink.
timestampstring (date-time)UTC time of the check, in RFC 3339.
uptime_secondsintegerSeconds since the HTTP service started.

Note

The health check confirms that the HTTP service responds. It does not check the availability of the service dependencies.