MicroStrategy REST API API Documentation
Get the list of devices
GET {{baseUrl}}/api/v2/devices
Get a list of all devices that the authenticated user has access to. This endpoint returns the name, ID, and other information about devices. You obtain the authorization token needed to execute the request using POST /auth/login. You pass the authorization token in the request header. You specify the type of device as query parameter. Default value is all
Body
PARAM
| Key | Datatype | Required | Description |
deviceType
|
string | Device type, Supported values are: email, file, ftp, printer, ipad, iphone, android, all. | |
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
| {
"devices": [
{
"id": "DD9271798EAE4992B41CA9BAE9A8AEE7",
"name": "Apple Push Notifications for Dossier on iPad",
"description": "Provides Apple Push Notification Service support for the Dossier iPad app",
"dateCreated": "2017-03-06T22:27:34+0000",
"dateModified": "2022-01-04T00:56:50+0000",
"deviceType": "ipad",
"transmitter": {
"id": "0CBB32A852984F098E72AC4690DEFF38",
"name": "Mobile Client iPad"
},
"deviceProperties": {
"ipad": {
"appId": "com.microstrategy.dossier.ipad",
"server": "api.push.apple.com",
"port": 443,
"providerCertificate": "/opt/mstr/MicroStrategy/install/CollaborationServer/apns-prod.pem",
"feedbackServiceServer": "feedback.push.apple.com",
"feedbackServicePort": 2196
}
}
},
{
"id": "E206C75BABC441C5B13B60C5D956F605",
"name": "Apple Push Notifications for Dossier on iPhone",
"description": "Provides Apple Push Notification Service support for the Dossier iPhone app",
"dateCreated": "2018-01-26T18:43:04+0000",
Curl curl -X GET 'baseUrl/api/v2/devices?deviceType=iphone&fields=' -H 'X-MSTR-AuthToken: authToken' ENDPOINTS |