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

# Readiness check

> Readiness probe - returns 200 only if dependencies are ready



## OpenAPI

````yaml /api-reference/openapi/Evo-Auth-Service/health.yaml get /ready
openapi: 3.0.1
info:
  title: Evolution Foundation - Auth Service - Health
  description: Authentication and user and account management
  version: v1.0.0
servers:
  - url: https://api.evoai.app
    description: Production server
  - url: http://localhost:3001
    description: Development server
    variables:
      port:
        default: '3001'
  - url: '{customUrl}'
    description: Custom server
    variables:
      customUrl:
        default: https://your-instance.com
        description: Enter your server URL
security: []
paths:
  /ready:
    get:
      summary: Readiness check
      description: Readiness probe - returns 200 only if dependencies are ready
      operationId: readinessCheck
      responses:
        '200':
          description: Service is ready
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Overall service readiness status
                    example: healthy
                  timestamp:
                    type: string
                    format: date-time
                    description: Response timestamp
                    example: 2026-01-28T22:09:02.538776+00:00Z
                  duration:
                    type: string
                    description: Total readiness check duration
                    example: 0.069s
                  components:
                    type: array
                    description: Array of component readiness checks
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: Component name
                          example: database_ping
                        status:
                          type: string
                          description: Component readiness status
                          example: healthy
                        message:
                          type: string
                          description: Component status message
                          example: Database ping successful
                        details:
                          type: object
                          nullable: true
                          description: Additional component details
                        timestamp:
                          type: string
                          format: date-time
                          description: Component check timestamp
                          example: 2026-01-28T22:09:02.513767+00:00Z
                        duration:
                          type: string
                          description: Component check duration
                          example: 0.044s
              example:
                status: healthy
                timestamp: 2026-01-28T22:09:02.538776+00:00Z
                duration: 0.069s
                components:
                  - name: database_ping
                    status: healthy
                    message: Database ping successful
                    details: null
                    timestamp: 2026-01-28T22:09:02.513767+00:00Z
                    duration: 0.044s
                  - name: redis
                    status: healthy
                    message: Redis is healthy
                    details:
                      connected_clients: 324
                      used_memory_human: 6.06M
                      redis_version: 7.4.7
                    timestamp: 2026-01-28T22:09:02.538566+00:00Z
                    duration: 0.003s
        '400':
          description: Bad Request (invalid data)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                validation_error:
                  summary: Invalid request parameters
                  value:
                    success: false
                    error:
                      code: VALIDATION_ERROR
                      message: Invalid request parameters
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /ready
                      method: GET
        '401':
          description: Unauthorized (invalid or missing token)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized access
                  value:
                    success: false
                    error:
                      code: INVALID_TOKEN
                      message: Invalid token
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /ready
                      method: GET
        '403':
          description: Forbidden (insufficient permissions)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                forbidden:
                  summary: Access forbidden
                  value:
                    success: false
                    error:
                      code: FORBIDDEN
                      message: You do not have permission to access this resource
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /ready
                      method: GET
        '404':
          description: Not Found (resource not found)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                not_found:
                  summary: Resource not found
                  value:
                    success: false
                    error:
                      code: NOT_FOUND
                      message: Readiness endpoint not found
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /ready
                      method: GET
        '500':
          description: Internal Server Error (server error)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                internal_error:
                  summary: Internal server error
                  value:
                    success: false
                    error:
                      code: INTERNAL_ERROR
                      message: An unexpected error occurred
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /ready
                      method: GET
        '503':
          description: Service Unavailable (service not available)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                service_unavailable:
                  summary: Service is not ready
                  value:
                    success: false
                    error:
                      code: SERVICE_UNAVAILABLE
                      message: Service is not ready
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /ready
                      method: GET
      security:
        - ApiAccessTokenAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      required:
        - success
        - error
        - meta
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: VALIDATION_ERROR
            message:
              type: string
              example: Validation failed
            details:
              type: object
              additionalProperties: true
              nullable: true
        meta:
          type: object
          required:
            - timestamp
            - path
            - method
          properties:
            timestamp:
              type: string
              format: date-time
              example: '2024-01-15T10:30:00Z'
            path:
              type: string
              example: /api/v1/super_admin/accounts/123
            method:
              type: string
              example: POST
  securitySchemes:
    ApiAccessTokenAuth:
      type: apiKey
      in: header
      name: api_access_token
      description: API access token authentication

````

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