Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.arcpass.vibepas.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to verify that the ArcPass API is running and responsive. It returns the service status and how long the API process has been running. No authentication or parameters are required.

​
Request

GET /health This endpoint takes no path parameters, query parameters, or request body.

​
Response

​
status
string
required
Current service status. Returns "ok" when the API is healthy and accepting requests.
​
uptime
integer
required
Number of seconds the API process has been running since its last restart, rounded down to the nearest whole second.

​
Use cases

  • Monitoring and alerting — poll this endpoint from your uptime monitor to detect outages.
  • Pre-flight checks — call /health before starting an integration test run to confirm the API is reachable.
  • Load balancer probes — configure your infrastructure to use this route as a health probe target.
curl --request GET \
  --url https://api.arcpass.io/health
200
{
  "status": "ok",
  "uptime": 48312
}