Skip to main content
GET
/
health
Health Check
curl --request GET \
  --url https://auth.nullpass.xyz/api/health
{
  "service": "nullpass",
  "version": "1.0.0",
  "status": "ok"
}

​
Endpoint

GET /api/health

​
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

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

​
Implementation Details

​
Code Reference

export async function GET(request: NextRequest) {
  const corsResponse = handleCors(request)
  if (corsResponse) return corsResponse

  const blocked = await protectRoute(request, { requested: 0.5 })
  if (blocked) return blocked

  return jsonResponse(
    {
      service: 'nullpass',
      version: '1.0.0',
      status: 'ok',
    },
    200,
    request.headers.get('origin')
  )
}

​
Status Codes

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

​
Example Request

curl --request GET \
  --url https://auth.nullpass.xyz/api/health \
  --header 'Accept: application/json'

​
Example Response

{
  "service": "nullpass",
  "version": "1.0.0",
  "status": "ok"
}

​
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"