Health Check Endpoint Designer
Design and generate health check endpoint JSON response schemas with component checks, HTTP status mapping, and Kubernetes probe formats.
About This Tool
The Health Check Endpoint Designer is a free browser-based tool that helps you create well-structured health check endpoint JSON responses for your APIs and microservices. Instead of writing boilerplate JSON by hand, select a response format (simple, detailed, or Kubernetes probe), add component checks for your dependencies (database, Redis, external APIs, disk space, memory, message queues), configure their statuses, and generate a properly formatted JSON response body.
The tool supports three industry-standard response formats. Simple returns just an UP or DOWN status, suitable for basic load balancer checks. Detailed includes per-component health information with durations and messages, following the pattern recommended by cloud-native monitoring tools. Kubernetes generates responses tailored for liveness, readiness, and startup probes used in container orchestration.
HTTP status codes are automatically mapped: 200 for healthy, 503 for unhealthy, and 429 for degraded states. The overall status can be auto-derived from component checks or set manually.
If you work with Kubernetes, the K8s Manifest Validator can verify your probe configurations. For building Docker containers that include health checks, try the Docker Run Command Builder. And to format the generated JSON output, use the JSON Formatter.
All processing runs entirely in your browser. No health check configurations, endpoints, or infrastructure details are ever sent to any server.
How to Use
- Select a Response Format from the dropdown: Simple (UP/DOWN), Detailed (with components), or Kubernetes (liveness/readiness/startup).
- If using Kubernetes format, choose the Probe Type (liveness, readiness, or startup).
- Add Component Checks using the dropdown: database, Redis, external API, disk space, memory, queue, or custom.
- Configure each component's name, status (UP/DOWN/DEGRADED/UNKNOWN), duration, and message.
- The Overall Status is auto-derived from components, or toggle off auto-derive to set it manually.
- Review the Generated Response JSON with syntax highlighting in the output panel. Note the HTTP status code badge.
- Click Copy or press Ctrl+Shift+C to copy the JSON. Click Download to save as a
.jsonfile.
Popular Health Check Examples
FAQ
What response formats are supported?
Three formats are supported: Simple (just status UP/DOWN), Detailed (status with per-component checks, timestamps, durations, and messages), and Kubernetes (formatted for liveness, readiness, and startup probe endpoints). Each format follows industry conventions for health check endpoints.
How are HTTP status codes determined?
The tool maps overall health status to HTTP status codes: 200 OK for healthy (UP), 503 Service Unavailable for unhealthy (DOWN), and 429 Too Many Requests for degraded states. These mappings follow common conventions used by load balancers and monitoring systems to detect service health.
What is the difference between Kubernetes liveness, readiness, and startup probes?
Liveness probes detect if your application is stuck (deadlocked) and trigger a container restart. Readiness probes check if your app can handle traffic and remove it from the service if not. Startup probes run only during initialization to give slow-starting apps time to boot before liveness probes kick in.
Can I customize the component check names?
Yes. After adding a component check, you can edit its name, status, duration, and message directly in the input fields. The name field accepts any string, so you can use names that match your actual infrastructure components.
How does auto-derive status work?
When auto-derive is enabled, the overall status is computed from component checks: if any component is DOWN, the overall status is DOWN; if any is DEGRADED or UNKNOWN, it becomes DEGRADED; otherwise it is UP. You can disable auto-derive to set the overall status manually.
Is my data safe?
Yes. All JSON generation runs entirely in your browser using JavaScript. No health check configurations, component names, or infrastructure details are ever sent to any server. You can verify this by checking the Network tab in your browser's developer tools.
Can I use the generated JSON directly in my codebase?
Yes. The generated JSON is valid and can be copied directly into your health check endpoint implementation. Use the Copy button or Ctrl+Shift+C to copy, or Download to save as a .json file. The JSON follows standard formatting conventions that most health check libraries expect.
Related Tools
JSON Formatter
Format, validate, and beautify JSON with syntax highlighting and tree view.
K8s Manifest Validator
Validate Kubernetes YAML manifests for common issues — missing fields, deprecated APIs, security misconfigs, and best practice violations.
Docker Run Command Builder
Build docker run commands visually with ports, volumes, env vars, and generate docker-compose.yml.
K8s Pod Spec Builder
Visually build Kubernetes Pod, Deployment, StatefulSet, and DaemonSet YAML manifests with containers, probes, volumes, and tolerations.
API Response Mocker
Generate realistic mock API responses with custom schemas, pagination, and error templates for frontend testing.
Uptime Calculator
Calculate SLA uptime percentages and equivalent downtime in days, hours, minutes, and seconds. Compare nines of availability with reverse downtime calculator.
Feature Flag Config Generator
Generate feature flag configuration templates for LaunchDarkly, Unleash, JSON, and YAML with targeting rules, rollouts, and user segments.
Log Format Parser
Parse and color-code server logs from Apache, Nginx, JSON, syslog, Docker, and Kubernetes formats with severity filtering and statistics.