The new docs.trellix.com features a modernized UI and AI-powered conversational search. Content is currently available in English, with additional languages launching in early November 2026. We hope you enjoy the updated experience.

Fetch user data

Prev Next

This URL fetches user data for a given cluster. The user data is used in deploying a Sensor.

Resource URL

GET /cluster/userdata

Request Parameters

URL Parameters:

Field Name

Description

Data Type

Mandatory

clusterName

Name of the cluster

string

Yes

Payload Parameters:

None

Response Parameters

The following fields are returned in the response:

Field Name

Description

Data Type

success

Indicates if the GET operation was successful.

Value is set to true if GET operation is successful.

Value is set to false if GET operation is not successful.

string

msg

Displays the message if the GET operation is successful.

string

data

Displays the userdata details.

object

Details of data object:

Field Name

Description

Data Type

Primary Manager IP

IP address of the primary Manager

string

Secondary Manager IP

IP address of the secondary Manager

string

Cluster Name

Name of the cluster

string

Sensor Shared Key

Shared secret key

string

Traffic Mode

Mode of the traffic

string

Example

Request

GET https://<NSM_IP>/intruvert/webservice/api/v1/cloud/cluster/userdata

Response

{
 "success": true,
 "msg": "Success",
 "data": {
 "Primary Manager IP": "10.100.10.10",
 "Secondary Manager IP": "",
 "Cluster Name": "cluster-name",
 "Sensor Shared Key": "",
 "Traffic Mode": "PROBE"
 }
}