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

# Check Instance Health

> Check the current health status of a WhatsApp instance by its UUID to monitor connectivity and readiness.

Check the current health status and connection state of your WhatsApp instance using its UUID.

## Rate Limit

This endpoint is limited to **10 requests per minute** to prevent abuse and ensure system stability.

## Response Fields

* `instance_id` - The UUID of your WhatsApp instance
* `connected_at` - Timestamp when the instance was connected
* `status` - Current status of the instance

## Instance Status Values

* `STOPPED`: Instance is stopped
* `STARTING`: Instance is starting up
* `WORKING`: Instance is running and ready to use
* `SCAN_QR_CODE`: Waiting for QR code to be scanned
* `FAILED`: Instance failed to start
* `PENDING`: Awaiting server assignment

## Use Cases

* Monitor instance health in your dashboard
* Verify instance is ready before sending messages
* Troubleshoot connection issues
* Automated health checks in monitoring systems

<Tip>
  Check the instance health before attempting to send messages to ensure the instance is in `WORKING` status.
</Tip>


## OpenAPI

````yaml v1/api-reference/enterprise/enterprise-collection.json GET /{instance}/health
openapi: 3.1.0
info:
  version: v1.0
  title: Hypersender Enterprise API Docs
  description: >

    The Hypersender Enterprise API provides powerful management capabilities for
    WhatsApp instances.


    In this Docs you'll learn how to use and integrate Hypersender Enterprise
    API into your existing system/service or application using simple API
    endpoints.


    **What you can Do?**


    - Check instance health status

    - List all instances with filtering

    - Create new WhatsApp instances

    - Request new QR codes for authentication

    - Restart instances


    <hr />


    ## Servers (Endpoints)


    - Production (activated):
    [https://app.hypersender.com/api/whatsapp/v1](https://app.hypersender.com/api/whatsapp/v1)
servers:
  - url: https://app.hypersender.com/api/whatsapp/v1
    description: Production
security:
  - Authorization: []
paths:
  /{instance}/health:
    get:
      tags:
        - Instance Management
      summary: Check Instance Health
      description: >-
        Checks the current health status of a WhatsApp instance by its UUID.
        This endpoint is limited to 10 requests per minute.
      parameters:
        - name: Accept
          in: header
          description: application/json
          schema:
            type: string
            example: application/json
        - name: instance
          in: path
          description: Instance UUID copied from hypersender dashboard
          required: true
          schema:
            type: string
            example: '{{ instance_id }}'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  instance_id:
                    type: string
                    example: fa3d01c4-1234-4c0d-a12f-df319b612f8c
                  connected_at:
                    type: string
                    example: '2025-05-26T10:12:45'
                  status:
                    type: string
                    enum:
                      - STOPPED
                      - STARTING
                      - WORKING
                      - SCAN_QR_CODE
                      - FAILED
                      - PENDING
                    example: WORKING
                    description: |-
                      Instance status:
                      - STOPPED: Instance is stopped
                      - STARTING: Instance is starting
                      - WORKING: Instance is running and ready
                      - SCAN_QR_CODE: Waiting for QR code to be scanned
                      - FAILED: Instance failed to start
                      - PENDING: Awaiting server assignment
        '404':
          description: Instance not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests. Please try again later.
      security:
        - Authorization: []
components:
  schemas:
    NotFoundError:
      type: object
      title: NotFoundError
      example:
        message: Resource not found.
      properties:
        message:
          type: string
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: >-
        Bearer token authentication. Example: `Bearer
        234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1`

````