---
title: "EP-24 — Health"
url: "https://dev.ionova.ai/apis/ars-address-resolution-service-4/versions/fdd2c316-7f84-4f04-8bb7-64e9bf97893b/operations/getHealth"
---

> Full API specification: https://dev.ionova.ai/apis/ars-address-resolution-service-4/versions/fdd2c316-7f84-4f04-8bb7-64e9bf97893b.md

# EP-24 — Health

`GET` `/health`

Operation ID: `getHealth`

Returns the operational status of the ARS service. No API key or bearer token required. Suitable for uptime monitoring, load balancer health probes, and status dashboards.

## Header parameters

- `X-Request-ID` (string, uuid, optional) - Client-supplied correlation ID echoed in response headers for tracing.

## Responses

- `200` - Health status returned
- `500` - Internal Server Error — unexpected server-side failure.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: ARS — Address Resolution Service
  version: 4.3.1
servers:
  - url: https://api-uat.ionova.ai/ars
    description: UAT (test data only)
paths:
  /health:
    get:
      tags:
        - Layer 5 — Health
      summary: EP-24 — Health
      description: >
        Returns the operational status of the ARS service. No API key or bearer
        token required.

        Suitable for uptime monitoring, load balancer health probes, and status
        dashboards.
      operationId: getHealth
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: "#/components/parameters/XRequestId"
      responses:
        "200":
          description: Health status returned
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HealthResponse"
        "500":
          $ref: "#/components/responses/InternalServerError"
security:
  - ApiKeyAuth: []
components:
  parameters:
    XRequestId:
      name: X-Request-ID
      in: header
      required: false
      schema:
        type: string
        format: uuid
      description: Client-supplied correlation ID echoed in response headers for tracing.
  schemas:
    HealthResponse:
      type: object
      xml:
        name: HealthResponse
      properties:
        status:
          type: string
          enum:
            - healthy
            - degraded
            - unhealthy
          description: Operational status of the ARS service.
        version:
          type: string
          description: Current ARS version (e.g. 4.3.0).
          example: 4.3.0
        timestamp:
          type: string
          format: date-time
          description: Current server time in ISO 8601 UTC format.
    ErrorResponse:
      type: object
      xml:
        name: ErrorResponse
      description: Standard error envelope returned on 4xx and 5xx responses.
      properties:
        code:
          type: integer
          description: HTTP status code.
        message:
          type: string
          description: Human-readable error description.
        requestId:
          type: string
          description: Correlation ID for support.
  responses:
    InternalServerError:
      description: Internal Server Error — unexpected server-side failure.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
          example:
            code: 500
            message: An unexpected error occurred. Please contact support with your
              requestId.
            requestId: b1a2c3d4-0000-0000-0000-000000000006
        application/xml:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
          example: |
            <?xml version="1.0" encoding="UTF-8"?>
            <ErrorResponse>
              <code>500</code>
              <message>An unexpected error occurred.</message>
              <requestId>b1a2c3d4-0000-0000-0000-000000000006</requestId>
            </ErrorResponse>
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your ioNova platform API key. Generate it from your organisation
        admin in the ioNova app, then paste it here to test.
```