Skip to main content

GET resource health

Returns a collection with the current resources health per state.

Request

HTTP request

GET https://api-sync-resser.azurewebsites.net/api/health

Parameters

The following table lists the parameters that this query supports. All of the parameters listed are query parameters.

Filters

PropertiesTypeDescription
countryCodestringThis parameter is used to get health stats for a specific country. It is the value of country code in the Country object.

Request body

This request does not require a request body during its execution, so please refrain from providing one when calling this method.

Response

Upon successful execution, this method returns a collection of health objects representing the current health status of all Sync resources, organized by state and resource type. If filters are provided, the response will only contain the health objects that match the filters.

Errors

The following table provides a list of potential error messages that the API may return in response to a call to this method. For more detailed information, please refer to the error message documentation.

Error typeError detailDescription
unauthorize (401)UnauthorizeThe requester is not allowed to use this request.