# healthCheck

Health check

Endpoint: GET /health
Version: v2

## Header parameters:

  - `x-correlation-id` (string)
    A unique transaction id used to correlate api requests end to end.
    Example: "123e4567-e89b-12d3-a456-426614174000"

## Response 200 fields (application/json):

  - `applicationName` (string, required)
    Application Name

  - `applicationVersion` (string, required)
    Application Version
    Example: "1.0.2"

  - `apiName` (string, required)
    API Name
    Example: "serv-titles-sapi"

  - `environment` (string, required)
    Environment
    Example: "DEV"

  - `status` (string, required)
    Status
    Example: "running"

## Response 400 fields (application/json):

  - `code` (integer)
    HTTP status code of the error.
    Example: 400

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "ESB:BAD_REQUEST"

  - `description` (string)
    Detailed error message.
    Example: "Invalid request parameters."

  - `correlationId` (string)
    Unique transaction id used to correlate api requests end to end.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `timestamp` (string)
    Timestamp of the error occurrence.
    Example: "2023-10-01T12:00:00Z"

## Response 401 fields (application/json):

  - `code` (integer)
    HTTP status code of the error.
    Example: 400

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "ESB:BAD_REQUEST"

  - `description` (string)
    Detailed error message.
    Example: "Invalid request parameters."

  - `correlationId` (string)
    Unique transaction id used to correlate api requests end to end.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `timestamp` (string)
    Timestamp of the error occurrence.
    Example: "2023-10-01T12:00:00Z"

## Response 403 fields (application/json):

  - `code` (integer)
    HTTP status code of the error.
    Example: 400

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "ESB:BAD_REQUEST"

  - `description` (string)
    Detailed error message.
    Example: "Invalid request parameters."

  - `correlationId` (string)
    Unique transaction id used to correlate api requests end to end.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `timestamp` (string)
    Timestamp of the error occurrence.
    Example: "2023-10-01T12:00:00Z"

## Response 404 fields (application/json):

  - `code` (integer)
    HTTP status code of the error.
    Example: 400

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "ESB:BAD_REQUEST"

  - `description` (string)
    Detailed error message.
    Example: "Invalid request parameters."

  - `correlationId` (string)
    Unique transaction id used to correlate api requests end to end.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `timestamp` (string)
    Timestamp of the error occurrence.
    Example: "2023-10-01T12:00:00Z"

## Response 429 fields (application/json):

  - `code` (integer)
    HTTP status code of the error.
    Example: 400

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "ESB:BAD_REQUEST"

  - `description` (string)
    Detailed error message.
    Example: "Invalid request parameters."

  - `correlationId` (string)
    Unique transaction id used to correlate api requests end to end.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `timestamp` (string)
    Timestamp of the error occurrence.
    Example: "2023-10-01T12:00:00Z"

## Response 500 fields (application/json):

  - `code` (integer)
    HTTP status code of the error.
    Example: 400

  - `errorType` (string)
    Stable error code that can be used to decide how to hand an error.
    Example: "ESB:BAD_REQUEST"

  - `description` (string)
    Detailed error message.
    Example: "Invalid request parameters."

  - `correlationId` (string)
    Unique transaction id used to correlate api requests end to end.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `timestamp` (string)
    Timestamp of the error occurrence.
    Example: "2023-10-01T12:00:00Z"