v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Health

Check the Health

Returns the operational status of the service.

get/v1/health

Query parameters

deepCheckstring

Headers

Tenantstring

Tenant company code for scoped data access during the request.

FrontOfficeTenantIdinteger

An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.

RequestIdstring uuid required

The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.

Response

200 response

machineNamestring

The name of the server this instance of the service is running upon.

timestampstring date-time

The date and time of this request.