Health Api - Get Service Status

Get service health status.

HEAD {endpoint}/api/health?api-version=2024-01-01

URI 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