---
title: "Get the health of all the adapters"
method: GET
path: "/health/adapters"
tags: ["Health"]
---

# Get the health of all the adapters

`GET /health/adapters`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/health/adapters`
- Auth: none declared

Returns the health of all the adapters in Itential Platform.

## Query parameters

- `contains` string
- `containsField` string
- `equals` string
- `equalsField` string
- `startsWith` string
- `startsWithField` string
- `skip` integer: Number of results to skip. Used for pagination.
- `limit` integer: Number of results to return. Used for pagination.
- `sort` 'name': Field to sort by. Default is name.
- `order` '-1' | '1': The sort direction: 1 for ascending or -1 for descending.

## Response `200`

Contains the adapters health data.

- HealthGetAdaptersHealthResponse200
  - `results` IapServicesHealthSchema[]
    - `id` string
    - `package_id` string: The model used by the service
    - `version` string
    - `type` 'Adapter' | 'Application'
    - `description` string
    - `state` 'DEAD' | 'STOPPED' | 'RUNNING' | 'DELETED'
    - `connection` union
      - unknown
      - IapServicesHealthSchemaConnection1
        - `state` string
    - `uptime` number, double: Number of seconds the current process has been running.
    - `memoryUsage` IapServicesHealthSchemaMemoryUsage
      - `rss` integer: Resident Set Size - the amount of space occupied in the main memory - in bytes
      - `heapTotal` integer: Heap Total in bytes for the Node V8 engine
      - `heapUsed` integer: Heap Used in bytes by the Node V8 engine
      - `external` integer: External usage - memory usage of C++ objects bound to JavaScript objects managed by the Node V8 engine - in bytes
    - `cpuUsage` IapServicesHealthSchemaCpuUsage: Contains microsecond data for user and system modes. These values are used to calculate CPU usage (with implied conversions) by the following formula : (current CPU usage - previous CPU usage) / (current uptime - previous uptime)
      - `user` integer: Microseconds spent in user mode
      - `system` integer: Microseconds spent in system mode
    - `pid` integer
    - `logger` IapServicesHealthSchemaLogger
      - `console` 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'spam'
      - `file` 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'spam'
      - `syslog` 'debug' | 'info' | 'warning' | 'error'
    - `routePrefix` string
    - `prevUptime` number, double
  - `total` integer: The total number of documents

## Other responses

- `500`: Error response from API

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)