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

# Health check

> Returns service health status and uptime.



## OpenAPI

````yaml openapi.json get /health
openapi: 3.0.3
info:
  title: Prvue Orchestrator API
  version: 0.1.0
  description: >-
    API for the preview deployer orchestrator: health checks, GitHub webhook,
    and preview lifecycle (list/delete).
servers:
  - url: http://localhost:3000
    description: Orchestrator API (on server; default ORCHESTRATOR_PORT)
security: []
paths:
  /health:
    get:
      tags:
        - Health
      summary: Health check
      description: Returns service health status and uptime.
      operationId: getHealth
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
components:
  schemas:
    HealthResponse:
      type: object
      required:
        - status
        - timestamp
        - uptime
      properties:
        status:
          type: string
          example: ok
        timestamp:
          type: string
          format: date-time
          description: ISO 8601 timestamp
        uptime:
          type: number
          description: Process uptime in seconds

````