Health

Description

The health module can be used to quickly check whenever the server is running or not. Furthermore, it allows to check other hardware specific information such as cpu, memory, disk space and uptime.

API

Endpoints

GET

Health Check

GET

Server Status

GET

Server Status (Deprecated)

Health Check

Calling this endpoint should return the status 200 and can be used to check the health of the server.

GET

/api/v1/health

Response

This endpoint simply returns Status 204 to indicate a successful operation and to save bandwidth.

Server Status

This endpoint offers the option to check for the server status and returns information regarding cpu, memory, disk space and uptime.

GET

/api/v1/health/status

Access

This endpoint requires read permission for the resource health.

Response

Name	Description
cpu object	This object contains CPU related health information.
cpu.cpuUsagePercent arraynumber	The current CPU usage for each core as percentage.
cpu.cpuAverageUsagePercent number	The average CPU usage for all cores combined as percentage.
memory object	Memory related process and system information.
memory.freeMemoryBytes integer	The number of free memory of the system in bytes.
memory.totalMemoryBytes integer	The number of total memory of the system in bytes.
memory.freeMemoryPercent number	The number of free memory of the system as percentage.
memory.processMemoryBytes integer	The number memory used by the process in bytes
disk object	This object contains information regarding the system disk space.
disk.freeDiskBytes integer	The number of free disk space of the system in bytes.
disk.totalDiskBytes integer	The number of total disk space of the system in bytes.
disk.freeDiskPercent integer	The number of free disk space of the system as percentage.
uptime object	System and Process uptime information.
uptime.systemUptimeSeconds integer	The uptime of the system in seconds.
uptime.processUptimeSeconds integer	The uptime of the process in seconds.
database object	Database related information.
database.status stringenum	The database connection status. The value `unused` is used, when no database has been configured and no data is persistently stored. Possible values: connected, disconnected, unused
version string	The installed version of the coldwave backend environment.

Server Status (Deprecated)

This endpoint offers the option to check for the server status and returns information regarding cpu, memory, disk space and uptime.

WARNING

This endpoint is deprecated. It will be changed to fit the camel-case key naming convention of any other endpoint with version five at the latest! Use the route /status in order to switch to the new format already.

GET

/api/v1/health/monitor

Access

This endpoint requires read permission for the resource health.

Response

Name	Description
cpu object	This object contains CPU related health information.
cpu.cpu-usage-percent arraynumber	The current CPU usage for each core as percentage.
cpu.average-cpu-usage-percent number	The average CPU usage for all cores combined as percentage.
memory object	Memory related process and system information.
memory.free-memory-bytes integer	The number of free memory of the system in bytes.
memory.total-memory-bytes integer	The number of total memory of the system in bytes.
memory.free-memory-percent number	The number of free memory of the system as percentage.
memory.process-memory-bytes integer	The number memory used by the process in bytes
disk object	This object contains information regarding the system disk space.
disk.free-disk-bytes integer	The number of free disk space of the system in bytes.
disk.total-disk-bytes integer	The number of total disk space of the system in bytes.
disk.free-disk-percent integer	The number of free disk space of the system as percentage.
uptime object	System and Process uptime information.
uptime.system-uptime-seconds integer	The uptime of the system in seconds.
uptime.process-uptime-seconds integer	The uptime of the process in seconds.
database-status stringenum	The database connection status. The value `undefined` is used, when no database has been configured and no data is persistently stored. Possible values: connected, disconnected, undefined