Health

Check the Health

Returns the operational status of the service.

get/v2/health

Request

  • Base URL
    https://api.avionte.com/talent
  • URL
    https://api.avionte.com/talent/v2/health
  • Auth
    API key in header x-api-key

Query parameters

deepCheckstring

If true, dependent services will be checked for availability.

Headers

RequestIdstring

Allows client-specified request correlation. Provided value must be a valid GUID.

Tenantstring required

A short code that indicates the tenant for which the request is being made.

Authorizationstring required

Contains the caller's access token, in the form "Bearer {token}", without quotes.

Response

Health

CanReadFromDynamoboolean

When deepCheck is requested, this will indicates if the DynamoDB tables are accessible.

MachineNamestring

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

Timestampstring date-time

The date and time of this request.

Changes

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