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

# Health check



## OpenAPI

````yaml /openapi.json get /health
openapi: 3.1.0
info:
  title: SuprLogs API
  version: 0.1.0
  description: >-
    SuprLogs lets you use our changelog database as the source of truth while
    building your own UI. This reference documents the **supported integration
    surface**: a health check, a projects endpoint (authenticated, returns your
    projects with published entries), and public changelog routes for listing
    and fetching individual posts by project slug. Create API keys in the
    dashboard (Settings → API Keys) to call authenticated routes.
  contact:
    name: SuprLogs Support
    url: https://suprlogs.com
    email: support@suprlogs.com
servers:
  - url: https://api.suprlogs.com
    description: Production
  - url: http://localhost:4704
    description: Local
security: []
paths:
  /health:
    get:
      summary: Health check
      operationId: getHealth
      responses:
        '200':
          description: Service health status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        status:
          type: string
          example: ok
        timestamp:
          type: string
          format: date-time
        service:
          type: string
          example: suprlogs-api
        nodeEnv:
          type: string
          example: development
      required:
        - status
        - timestamp
        - service
        - nodeEnv

````