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

# Check Webshare API health

> Checks the health of the Webshare proxy API. Requires admin role.



## OpenAPI

````yaml openapi.json get /api/admin/proxy/health
openapi: 3.0.0
info:
  title: Wappfy API
  description: >-
    WhatsApp API Platform — Manage instances, send messages, and build
    integrations.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.wappfy.io
    description: Production
security: []
tags:
  - name: Instances
    description: Create, connect, and manage WhatsApp instances (WAHA or Cloud API)
  - name: Messages
    description: >-
      Send messages via WhatsApp (text, media, location, poll, contacts, and
      more)
  - name: Chats
    description: List chats, read messages, mark as seen, and manage typing indicators
  - name: Groups
    description: Create and manage WhatsApp groups, participants, and invite links
  - name: Contacts
    description: Look up contacts, check phone numbers, and fetch profile pictures
  - name: Labels
    description: Organize chats with WhatsApp Business labels
  - name: Channels
    description: Create and manage WhatsApp Channels (newsletters)
  - name: Status
    description: Publish text status/stories
  - name: Presence
    description: Set and get online/offline presence
  - name: Webhooks
    description: Configure webhook endpoints to receive real-time event notifications
  - name: Admin
    description: >-
      Platform administration — user management, statistics, and proxy
      monitoring (admin only)
paths:
  /api/admin/proxy/health:
    get:
      tags:
        - Admin
      summary: Check Webshare API health
      description: Checks the health of the Webshare proxy API. Requires admin role.
      operationId: AdminController_checkProxyHealth
      parameters: []
      responses:
        '200':
          description: Proxy API health status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyHealthResponseDto'
        '401':
          description: Missing or invalid authentication token
        '403':
          description: Insufficient permissions
        '500':
          description: Internal server error
      security:
        - bearer: []
components:
  schemas:
    ProxyHealthResponseDto:
      type: object
      properties:
        status:
          type: string
          enum:
            - healthy
            - unhealthy
          description: Webshare API health status
        timestamp:
          type: string
          description: Health check timestamp
      required:
        - status
        - timestamp
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````