> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nullpass.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Health Check

> Check API service health and status

## 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

<ResponseField name="service" type="string">
  Service name: "nullpass"
</ResponseField>

<ResponseField name="version" type="string">
  API version: "1.0.0"
</ResponseField>

<ResponseField name="status" type="string">
  Service status: "ok"
</ResponseField>

## Implementation Details

### Code Reference

```5:21:nullpass_clean/src/app/api/health/route.ts theme={null}
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

<ResponseField name="200" type="OK">
  Service is healthy
</ResponseField>

<ResponseField name="403" type="Forbidden">
  Blocked by Arcjet (rate limit: 0.5 requests per bucket)
</ResponseField>

## Example Request

```bash theme={null}
curl --request GET \
  --url https://auth.nullpass.xyz/api/health \
  --header 'Accept: application/json'
```

## Example Response

```json theme={null}
{
  "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

<Tip>
  This endpoint has minimal rate limiting (0.5 requests per bucket) to allow frequent health checks.
</Tip>


## OpenAPI

````yaml GET /health
openapi: 3.1.0
info:
  title: Null Pass API
  description: >-
    Internal API documentation for Null Pass authentication and service
    management system
  version: 1.0.0
servers:
  - url: https://auth.nullpass.xyz/api
security: []
paths:
  /health:
    get:
      tags:
        - System
      summary: Health Check
      description: Check API service health and status
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '403':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        service:
          type: string
          example: nullpass
        version:
          type: string
          example: 1.0.0
        status:
          type: string
          example: ok
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
        message:
          type: string

````