Sign in
Health

Liveness probe

Changed on

Returns service identity, current environment, and a server timestamp. Always public.

get/api/v1/health

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/v1/health
  • Auth: none declared

Response

Service is up.

oktrue required
servicestring required
env'local' | 'staging' | 'production' required
tsstring date-time required

ISO 8601 timestamp of the probe.

Example response

{
  "service": "bunkai-tms"
}

Changes

  • 4528999528c6Revision changes
    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

  • 2ca74ff5fec5Revision changes
    • info

      removed the test_outside_plan_project enum value from the / response property for the response status