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

# Health check

> Returns the current health status of the API



## OpenAPI

````yaml https://vortexpdf.com/openapi get /api/v1/health
openapi: 3.0.0
info:
  title: Vortex PDF
  version: '1.0'
servers:
  - url: https://vortexpdf.com
    variables: {}
security: []
tags: []
paths:
  /api/v1/health:
    get:
      tags:
        - Vortex
      summary: Health check
      description: Returns the current health status of the API
      operationId: VortexWeb.HealthController.show
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/health_response'
          description: Health status
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/auth_error_response'
          description: Unauthorized
      callbacks: {}
      security:
        - authorization: []
components:
  schemas:
    health_response:
      description: Response from the health check endpoint
      example:
        current_user:
          email: user@example.com
          id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        status: operational
      properties:
        current_user:
          description: Information about the authenticated user
          properties:
            email:
              description: The current user email
              format: email
              type: string
            id:
              description: The current user ID
              format: uuid
              type: string
          required:
            - id
            - email
          type: object
        status:
          description: The current health status of the API
          enum:
            - operational
            - degraded
            - major
          type: string
      required:
        - status
        - current_user
      title: health_response
      type: object
    auth_error_response:
      description: Response when authentication or authorization fails
      example:
        error: unauthorized
        message: Authentication required to access this resource
      properties:
        error:
          description: Error message describing the authentication or authorization failure
          enum:
            - unauthorized
            - forbidden
            - invalid_token
            - expired_token
            - insufficient_permissions
          type: string
        message:
          description: A more detailed message explaining the error
          type: string
      required:
        - error
      title: auth_error_response
      type: object
  securitySchemes:
    authorization:
      description: Manage your API keys at https://vortexpdf.com/api-keys
      scheme: bearer
      type: http

````