Check Health
GET {{URL}}/v1/health
Send a
GET
call to the
/v1/health
endpoint to retrieve the health status of your WhatsApp Business API client.
Parameters
| Name | Description |
|---|---|
health
Type: Object | Contains the fields that describe the health of the WhatsApp Business API client. |
gateway_status
Type: String |
Status of the connection between the Coreapp and WhatsApp servers.
Supported values:
|
role
Type: String |
Th role of the container in High Availability/Multiconnect setups. See the
Availability and Scaling documentation
for more information on these setups.
Supported values:
primary_master
,
secondary_master
,
coreapp
|
Response
Single Instance
The response provides the status of the health of the gateway to the WhatsApp server. If the
Authorization
header is not present or invalid, a
401
error code is returned.
High Availability/Multiconnect
In High Availability mode, only one Coreapp is connected to the WhatsApp server, all other nodes including the primary Master have a
gateway_status
of
disconnected
. In Multiconnect mode with
X
shards,
X
Coreapps are connected to the WhatsApp server, and the primary Master connects to the WhatsApp server. To learn more about High Availability/Multiconnect mode, see
Availability and Scaling guide
.
HEADERS
| Key | Datatype | Required | Description |
| Authorization | string | | |
RESPONSES
status: OK
{"health":{"your-hostname1:your-container-id1":{"gateway_status":"connected | connecting | disconnected | uninitialized | unregistered","role":"primary_master | secondary_master | coreapp"},"your-hostname2:your-container-id2":{"gateway_status":"connected | connecting | disconnected | uninitialized | unregistered","role":"primary_master | secondary_master | coreapp"}},"meta":{"api_status":"stable","version":"v2.45.1"}}