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

# Get the health of the server

`GET /health/server`

## Request

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

Returns the health of the server.

## Response `200`

Contains the server health data.

- HealthGetServerHealthResponse200
  - `version` string
  - `release` string
  - `arch` 'arm' | 'arm64' | 'ia32' | 'mips' | 'mipsel' | 'ppc' | 'ppc64' | 's390' | 's390x' | 'x32' | 'x64'
  - `platform` 'aix' | 'darwin' | 'freebsd' | 'linux' | 'openbsd' | 'sunos' | 'win32'
  - `versions` HealthServerGetResponsesContentApplicationJsonSchemaVersions
    - `node` string
    - `v8` string
    - `uv` string
    - `zlib` string
    - `brotli` string
    - `ares` string
    - `modules` string
    - `nghttp2` string
    - `napi` string
    - `llhttp` string
    - `http_parser` string
    - `openssl` string
    - `cldr` string
    - `icu` string
    - `tz` string
    - `unicode` string
  - `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
  - `uptime` number, double: Number of seconds the current process has been running.
  - `pid` integer
  - `dependencies` HealthServerGetResponsesContentApplicationJsonSchemaDependencies
    - `@itential/logger` string
    - `@itential/database` string
    - `@itential/itential-utils` string

## 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)