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

# Get application health and version

> Checks database and storage availability. Does not require authentication.



## OpenAPI

````yaml /spec.json get /api/health
openapi: 3.1.1
info:
  title: Reactive Resume
  version: 6.0.2
  description: >-
    Reactive Resume API. Mutations do not support Idempotency-Key. Do not
    automatically retry POST, PUT, PATCH or DELETE requests after a timeout:
    first read the resource to determine whether the operation succeeded.
    Existing enum values and response shapes are retained for compatibility.
  license:
    name: MIT
    url: https://github.com/reactive-resume/reactive-resume/blob/main/LICENSE
  contact:
    name: Amruth Pillai
    email: amruth@rxresu.me
    url: https://amruthpillai.com
servers:
  - url: https://rxresu.me/api/openapi
security:
  - apiKey: []
  - bearerAuth: []
  - cookieAuth: []
externalDocs:
  url: https://docs.rxresu.me
  description: Reactive Resume Documentation
paths:
  /api/health:
    get:
      tags:
        - System
      summary: Get application health and version
      description: >-
        Checks database and storage availability. Does not require
        authentication.
      operationId: getHealth
      responses:
        '200':
          description: The application and its dependencies are healthy.
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    enum:
                      - reactive-resume
                  version:
                    type: string
                    description: The running application's build version.
                  status:
                    type: string
                    enum:
                      - healthy
                      - unhealthy
                  timestamp:
                    type: string
                    format: date-time
                  uptime:
                    type: string
                  database:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - healthy
                          - unhealthy
                      latencyMs:
                        type: number
                      error:
                        type: string
                        description: >-
                          Generic failure message. Detailed diagnostics are
                          logged on the server.
                    required:
                      - status
                      - latencyMs
                    additionalProperties: true
                  storage:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - healthy
                          - unhealthy
                      latencyMs:
                        type: number
                      error:
                        type: string
                        description: >-
                          Generic failure message. Detailed diagnostics are
                          logged on the server.
                    required:
                      - status
                      - latencyMs
                    additionalProperties: true
                required:
                  - service
                  - version
                  - status
                  - timestamp
                  - uptime
                  - database
                  - storage
        '503':
          description: One or more application dependencies are unhealthy.
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    enum:
                      - reactive-resume
                  version:
                    type: string
                    description: The running application's build version.
                  status:
                    type: string
                    enum:
                      - healthy
                      - unhealthy
                  timestamp:
                    type: string
                    format: date-time
                  uptime:
                    type: string
                  database:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - healthy
                          - unhealthy
                      latencyMs:
                        type: number
                      error:
                        type: string
                        description: >-
                          Generic failure message. Detailed diagnostics are
                          logged on the server.
                    required:
                      - status
                      - latencyMs
                    additionalProperties: true
                  storage:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - healthy
                          - unhealthy
                      latencyMs:
                        type: number
                      error:
                        type: string
                        description: >-
                          Generic failure message. Detailed diagnostics are
                          logged on the server.
                    required:
                      - status
                      - latencyMs
                    additionalProperties: true
                required:
                  - service
                  - version
                  - status
                  - timestamp
                  - uptime
                  - database
                  - storage
      security: []
      servers:
        - url: https://rxresu.me
      x-codeSamples:
        - lang: bash
          label: cURL
          source: curl "https://rxresu.me/api/health"
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: x-api-key
      in: header
      description: The API key to authenticate requests.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: An OAuth access token issued by this instance for its API/MCP resource.
    cookieAuth:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: >-
        Browser session (secure deployments use the __Secure- prefix). Cookie
        requests must originate from this instance.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.