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

# Get server health status

> Returns the server health status. The sentry status is also included in the response



## OpenAPI

````yaml get /health/
openapi: 3.0.3
info:
  title: Letraz Backend Server
  version: 0.1.0
  description: >-
    This is the backend service repository of Letraz. Create tailored resumes
    for every job application effortlessly with Letraz. Our AI-powered tool
    helps you stand out by automatically optimizing your resume for ATS and
    recruiters, ensuring your skills and experience match the job's
    requirements.
servers:
  - url: https://api.letraz.app/api/v1
    description: Production Server
  - url: http://localhost:8000/api/v1
    description: Local Development Server
security: []
tags:
  - name: Core APIs
    description: Core APIs for Letraz Backend
  - name: Waitlist
    description: >-
      Mange waitlist, signups, retrieve waitlist and everything related to
      waitlist
  - name: User
    description: Get or update user details of currently logged in user
  - name: Job object
    description: >-
      Manage job objects, retrieve job objects and everything related to job
      objects
  - name: Resume object
    description: >-
      Manage resume objects, retrieve resume objects and everything related to
      resume objects
  - name: Education object
    description: >-
      Manage education objects, retrieve education objects and everything
      related to education objects
  - name: Experience object
    description: >-
      Manage experience objects, retrieve experience objects and everything
      related to experience objects
paths:
  /health/:
    get:
      tags:
        - Core APIs
      summary: Get server health status
      description: >-
        Returns the server health status. The sentry status is also included in
        the response
      operationId: health_retrieve
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheck'
          description: ''
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheck'
          description: ''
components:
  schemas:
    HealthCheck:
      type: object
      properties:
        instance_id:
          type: string
          description: >-
            The id of the instance from which the health check response has been
            received.
        status:
          enum:
            - OPERATIONAL
            - DEGRADED
          type: string
          x-spec-enum-id: 893c6aabf915415a
          description: >-
            The health status of the server. The status can be ok, degraded or
            failing.


            * `OPERATIONAL` - OPERATIONAL

            * `DEGRADED` - DEGRADED
        details:
          $ref: '#/components/schemas/HealthDetails'
      required:
        - details
        - instance_id
        - status
    HealthDetails:
      type: object
      properties:
        sentry:
          enum:
            - OPERATIONAL
            - UNINITIALIZED
            - FAILED
          type: string
          x-spec-enum-id: 80e18a4a4884b03a
          description: >-
            The status of the sentry integration. If False, the sentry is not
            initialized, possibly due to absense of environment variables, which
            is expected or misconfigured initialization.


            * `OPERATIONAL` - OPERATIONAL

            * `UNINITIALIZED` - UNINITIALIZED

            * `FAILED` - FAILED
        clerk:
          enum:
            - OPERATIONAL
            - DOWN
          type: string
          x-spec-enum-id: b596af6019cf09ff
          description: >-
            The health status of Clerk integration. The status can be
            OPERATIONAL or DOWN.


            * `OPERATIONAL` - OPERATIONAL

            * `DOWN` - DOWN
        db:
          enum:
            - OPERATIONAL
            - DEGRADED
            - FATAL
          type: string
          x-spec-enum-id: 30d9ff093e6722d6
          description: >-
            The health status of  Clerk connection. The status can be
            OPERATIONAL, DEGRADED or FATAL.


            * `OPERATIONAL` - OPERATIONAL

            * `DEGRADED` - DEGRADED

            * `FATAL` - FATAL
        util_service:
          enum:
            - OPERATIONAL
            - DISCONNECTED
            - FAILED
          type: string
          x-spec-enum-id: 5b01acf14d7b5dd6
          description: >-
            The health status of gRPC:util connection. The status can be
            OPERATIONAL, DISCONNECTED or FAILED.


            * `OPERATIONAL` - OPERATIONAL

            * `DISCONNECTED` - DISCONNECTED

            * `FAILED` - FAILED
      required:
        - clerk
        - db
        - sentry
        - util_service

````