Logo
MicroStrategy REST API API Documentation

Get information about nodes in the connected Intelligence Server cluster

GET {{baseUrl}}/api/monitors/iServer/nodes

Get information about nodes in the connected Intelligence Server cluster. This includes basic information, runtime state and information of projects on each node. This operation requires the Monitor cluster privilege. You specify an authorization token in the request header.

 

Body PARAM

Key Datatype Required Description 
projects.id
string Project ID
name
string Node Name
fields
null Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model.



HEADERS

Key Datatype Required Description 
X-MSTR-AuthToken
string (Required) Authorization token




RESPONSES

status OK

Curl
curl -X GET 'baseUrl/api/monitors/iServer/nodes?projects.id=projectId&name=clusterNodeName&fields=' -H 'X-MSTR-AuthToken: authToken'

ENDPOINTS

    { "nodes": [ { "name": "env-276686laiouse1", "port": 34952, "status": "running", "load": 2, "projects": [ { "id": "B7CA92F04B9FAE8D941C3E9B7E0CD754", "name": "MicroStrategy Tutorial", "status": "loaded" }, { "id": "CE52831411E696C8BD2F0080EFD5AF44", "name": "Consolidated Education Project", "status": "loaded" } ], "default": true } ] }