---
title: "Check the Health"
method: GET
path: "/v1/health"
tags: ["Health"]
---

# Check the Health

`GET /v1/health`

## Request

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

Returns the operational status of the service.

## Query parameters

- `deepCheck` string

## Headers

- `RequestId` string, uuid: Unique request identifier in UUID format used to correlate request data to log entries and events.
- `FrontOfficeTenantId` integer
- `Tenant` string

## Response `200`

The health check results.

- Health: Holds basic information about the service's health.
  - `serviceVersion` Version
    - `major` integer
    - `minor` integer
    - `build` integer
    - `revision` integer
    - `majorRevision` integer
    - `minorRevision` integer
  - `machineName` string: The name of the server this instance of the service is running upon.
  - `timestamp` string, date-time: The date and time of this request.
  - `connectionStatus` string: The status of DB connection instance

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Access Denied
- `404`: Not found
- `405`: Unsupported method
- `406`: Unsupported format(s) indicated by Accept header
- `415`: Unsupported format(s) indicated by the Content-Type header
- `429`: Too many requests
- `500`: An unexpected error occurred
- `502`: Service Unavailable
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/avionte/apis/bold-front-office-api.md) - [All operations](https://skmtc.dev/avionte/apis/bold-front-office-api/llms.txt) - [OpenAPI document](https://skmtc.dev/avionte/apis/bold-front-office-api/revisions/bd5996cbaa0f?raw)