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

# API health check

> **System Function**: Performs a comprehensive health check on the DeFindex API.

This endpoint provides:
- API service availability and connectivity
- Database connection status (mainnet and testnet)
- Connection pool statistics

Useful for monitoring tools, load balancers, and operational dashboards.



## OpenAPI

````yaml GET /health
openapi: 3.0.0
info:
  title: DeFindex API
  description: API documentation for DeFindex endpoints
  version: 1.0.0
  contact: {}
  x-logo:
    url: https://links.paltalabs.io/defindex-full.svg
    backgroundColor: '#0e0e0e'
    altText: DeFindex Logo
    href: https://defindex.io
servers: []
security: []
tags: []
paths:
  /health:
    get:
      tags:
        - App
      summary: API health check
      description: >-
        **System Function**: Performs a comprehensive health check on the
        DeFindex API.


        This endpoint provides:

        - API service availability and connectivity

        - Database connection status (mainnet and testnet)

        - Connection pool statistics


        Useful for monitoring tools, load balancers, and operational dashboards.
      operationId: AppController_checkHealth
      parameters: []
      responses:
        '200':
          description: API is healthy and operational
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    properties:
                      reachable:
                        type: boolean
                        description: Whether the API is reachable and responding
                  indexer:
                    type: object
                    description: Indexer data source health status (database)
                    properties:
                      mainnet:
                        type: object
                        properties:
                          database:
                            type: object
                            properties:
                              configured:
                                type: boolean
                              healthy:
                                type: boolean
                              poolStats:
                                type: object
                                properties:
                                  totalCount:
                                    type: number
                                  idleCount:
                                    type: number
                                  waitingCount:
                                    type: number
                      testnet:
                        type: object
                        properties:
                          database:
                            type: object
        '500':
          description: API is experiencing issues
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    properties:
                      indexer:
                        type: string
                        description: Status of indexer service
                      reachable:
                        type: boolean
                        description: Whether the API is reachable
                      errors:
                        type: array
                        items:
                          type: string
                        description: Array of error messages if any

````

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