---
title: "Create interactive server console session"
method: POST
path: "/v1/server-console/session"
tags: ["Server Console"]
---

# Create interactive server console session

`POST /v1/server-console/session`

Create an interactive server console session and return a short-lived token for WebSocket
connection to `/v1/server-console/session/{token}`. This flow is designed to work with browser
WebSocket API which cannot send custom Authorization headers.

Session opening is recorded in the audit log. Requires SERVER_CONSOLE access right.

## Response `201`

Console session created

- object
  - `token` string, uuid — Single-use session token for WebSocket connection
  - `expiresIn` integer — Token validity period in seconds
  - `wsUrl` string — WebSocket URL path to connect to

## Other responses

- `401` — Unauthorized
- `403` — User does not have SERVER_CONSOLE access right

## Changes

- **2026-09-30** `a8eea04a807d` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/netxms/apis/netxms-api/changes/v1/server-console/session/post.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/129789f8868f?raw)