Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Health Api - Get Service Status
- Service:
- Azure Web PubSub Service
- API Version:
- 2024-01-01
Get service health status.
HEAD {endpoint}/api/health?api-version=2024-01-01URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (url) |
HTTP or HTTPS endpoint for the Web PubSub service instance. |
|
api-version
|
query | True |
string |
The version of the REST APIs. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
The service is healthy |
|
| Other Status Codes |
Error response |
Examples
HealthApi_GetServiceStatus
Sample request
HEAD {endpoint}/api/health?api-version=2024-01-01
Sample response
- Status code:
- 200