MicroStrategy REST API API Documentation
Update application status on nodes when iServer starts up.
PATCH {{baseUrl}}/api/projects/settings/onStartup
Update status of applications on iServer nodes at start up. You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header. You obtain the existing settings for the applications along with the list of nodes using GET /settings/onStartup. You provide the request body as of list of replace operations to be performed on the value of array of nodes with the path URI containing the corresponding project id that needs to be updated.
Body
PARAM
| Key | Datatype | Required | Description |
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 | |
Content-Type
|
string |
RESPONSES
status OK
| {
"projects": {
"C27E27288043EDAC6732179CD9E49F76": {
"name": "Small Cotton Chicken",
"id": "C27E27288043EDAC6732179CD9E49F76",
"nodes": [
"env-276686laiouse1"
]
},
"2847BB27B943E4CA4EAE1BBA2A5201F8": {
"name": "Incredible Frozen Shoes",
"id": "2847BB27B943E4CA4EAE1BBA2A5201F8",
"nodes": [
"env-276686laiouse1"
]
}
}
} |
Curl
curl -X PATCH 'baseUrl/api/projects/settings/onStartup?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'Content-Type: application/json' -d '{"operationList":[{"op":"replace","path":"/projects/C27E27288043EDAC6732179CD9E49F76/nodes","value":["env-276686laiouse1"]}]}'
ENDPOINTS