AVavionte
Health

Check the Health

Returns the operational status of the service.

get/v1/health

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/health
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

deepCheckstring

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

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

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

The health check results.

machineNamestring

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

timestampstring date-time

The date and time of this request.

connectionStatusstring

The status of DB connection instance

Changes

No recorded changes to this operation across all 1 revision of this API.