---
title: "Get server information"
method: GET
path: "/v1/server-info"
tags: ["Server"]
---

# Get server information

`GET /v1/server-info`

Retrieve detailed server information including version, build, and configuration details.

## Response `200`

Server information retrieved successfully

- object
  - `version` string — Server version
  - `build` string — Build tag
  - `id` integer — Server ID
  - `name` string — Server name
  - `color` string — Server color (for UI theming)
  - `messageOfTheDay` string — Message of the day
  - `tz` string — Server timezone
  - `options` object
    - `zoningEnabled` boolean
    - `strictAlarmStatusFlow` boolean
    - `timedAlarmAckEnabled` boolean
    - `helpdeskLinkActive` boolean
    - `dciAggregationEnabled` boolean — True if DCI data aggregation (hourly/daily tiers) is enabled on the server
    - `tileServerURL` string
  - `dateTimeFormat` object
    - `date` string — Date format string
    - `timeLong` string — Long time format string
    - `timeShort` string — Short time format string
  - `components` object[] — Registered server components
  - `clientConfigurationHints` object — Client configuration hints - server configuration variables with names starting with "Client." (prefix stripped), overlaid with attributes of the calling user that have the same prefix. This makes the response user-specific, so it must not be cached and shared between users.

## Other responses

- `401` — Unauthorized

## Changes

- **2026-09-15** `6eac6acac8bf` — 1 info
  - added the optional property `clientConfigurationHints` to the response with the `200` status
- **2026-05-28** `0fb96d68a8bf` — 1 info
  - added the optional property `options/dciAggregationEnabled` to the response with the `200` status
- **2026-05-08** `c6aaf3632e48` — 1 warning
  - removed the optional property `options/dciAggregationEnabled` from the response with the `200` status

[Change history](https://skmtc.dev/netxms/apis/netxms-api/changes/v1/server-info/get.md)

---

[API](https://skmtc.dev/netxms/apis/netxms-api.md) · [All operations](https://skmtc.dev/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc.dev/netxms/apis/netxms-api/revisions/6eac6acac8bf?raw)