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

# Check the Health

`GET /v1/health`

Returns the operational status of the service.

## Query parameters

- `deepCheck` string

## Headers

- `Tenant` string
- `FrontOfficeTenantId` integer
- `RequestId` string, uuid, required

## Response `200`

200 response

- Health
  - `compasIntegrationServiceVersion` object — The version number of the primary assembly for the service.
    - `major` integer — The major version of the API.
    - `minor` integer — The minor version of the API.
    - `build` integer — The build number of the API.
    - `revision` integer — The revision number of the API.
    - `majorRevision` integer — The major revision version of the API.
    - `minorRevision` integer — The minor revision version of the API.
  - `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.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Access Denied
- `404` — Not found
- `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

---

[API](https://skmtc.net/avionte/apis/aviont-partner-authorization-api.md) · [All operations](https://skmtc.net/avionte/apis/aviont-partner-authorization-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/avionte/aviont-partner-authorization-api/revisions/846b33e4e71b/schema)