Skip to main content
GET
Health Check

Endpoint

Overview

Returns the health status of the Null Pass API service. This endpoint is useful for monitoring and uptime checks.

Request

No authentication required. No request body or query parameters.

Response

string
Service name: “nullpass”
string
API version: “1.0.0”
string
Service status: “ok”

Implementation Details

Code Reference

Status Codes

OK
Service is healthy
Forbidden
Blocked by Arcjet (rate limit: 0.5 requests per bucket)

Example Request

Example Response

Use Cases

  • Monitoring: Health checks for uptime monitoring services
  • Load Balancers: Health check endpoint for load balancers
  • Status Pages: Public status page integration
  • CI/CD: Pre-deployment health verification
This endpoint has minimal rate limiting (0.5 requests per bucket) to allow frequent health checks.

Response

Service is healthy

service
string
Example:

"nullpass"

version
string
Example:

"1.0.0"

status
string
Example:

"ok"