Nodes

Nodes represent the session monitoring agent nodes that can be used for establishing sessions.

For more information on related topics, please see Sessions.

GET Nodes

Purpose

Returns a list of session monitoring agent nodes.

Query Parameters

includeInactive: (optional, default: false) True to return all nodes including nodes that are inactive, otherwise False.

Request Body

None.

Response Body

Content-Type: application/json

[
    {
        NodeID: string,
        HostName: string,
        DisplayName: string,
        LastHeartbeat: DateTime, // can be null
        IsActive: bool,
    },
    …
]

Response Body Details

• NodeID: Node unique ID.
• HostName: Node host name.
• DisplayName: Node display name.
• LastHeartbeat: The date and time of the last session monitoring agent heartbeat from this node.
• IsActive: True if the session monitoring agent is considered active and running, otherwise false.

Response Codes

200 - Request successful. Nodes in the response body.

For more information, please see Common Response Codes.