App Inventory Management
Get list of installed apps
This call returns a list of installed apps. The api can return apps from all platforms or specific platforms.
Required Role
See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.
|
Required Role |
|
Category: App Management Role Description: View app inventory |
HTTP method
GET
Request URI
/api/v2/appinventory/apps
Request parameters
|
Parameter |
Description |
Sample Value |
|
adminDeviceSpaceId |
Required Parameter Type: Query Data Type: Number Device space ID of the administrator. |
1 |
|
limit |
Parameter Type: Query Data Type: Number Min: 0 Indicates the maximum number of entries to return. Must be at least 0 and no more than 200. |
|
|
offset |
Parameter Type: Query Data Type: Number Min: 0 Max: 10,000,000 Default: 0 Indicates the index of the first entry to return. |
|
|
platformType |
Parameter Type: Query Data Type: Char Specifies from which platform to return installed apps. Default to return apps from all platforms. Valid values: I, A, M, E, Q •I = iOS •A = Android •M = Windows Phone •E = Windows 10 and Windows 8.1 •Q = Web Application |
A |
|
query |
Parameter Type: Query Data Type: String Specifies a search string for which to search in the app’s name. For example, searching for “weather” would return the “AccuWeather” app. |
weather |
|
sortField |
Parameter Type: Query Data Type: String Min: 1 character Max: 320 characters Name of the field to use for sorting. |
|
|
sortOrder |
Parameter Type: Query Data Type: String Default: ASC Indicates the order in which entries are returned. Values can be "ASC" or "DESC". |
ASC |
|
summaryView |
Parameter Type: Query Data Type: Boolean Default: false Summary view returns installed apps by app ID. Detailed view returns installed apps by ID and version. |
false |
Response fields
|
Field |
Description |
|
results |
An array of the following objects: inventory ID, name, app ID, platformType, version, displayName, deviceCount, permissionCount, appRating, appScore, dateFound |
|
totalCount |
The total number of entries that the query matched. |
|
resultCount |
The number of entries that are being returned. |
|
hasMore |
Indicates that there are more entries available. |
Sample request and response
Request
curl -k -v -sS -u <userName>:<password> -XGET 'https://[Ivanti EPMM]/api/v2/appinventory/apps?adminDeviceSpaceId=1&limit=2&query=casino&offset=0'
Response
{
"totalCount": 72906,
"resultCount": 2,
"hasMore": true,
"results": [
{
"id": 100109,
"name": "Casino CrapsAutoGenApp42188",
"identifier": "application.identifier.Casino CrapsAutoGenApp42188",
"platformType": "I",
"version": "1.0",
"displayVersion": "1.0",
"deviceCount": 0,
"permissionsCount": 0,
"appRating": 0,
"appScore": null,
"dateFound": 1447475953000
},
{
"id": 100110,
"name": "Casino CrapsAutoGenApp42189",
"identifier": "application.identifier.Casino CrapsAutoGenApp42189",
"platformType": "I",
"version": "3.3",
"displayVersion": "3.3",
"deviceCount": 0,
"permissionsCount": 0,
"appRating": 0,
"appScore": null,
"dateFound": 1447475953000
}
]
}
Get installed app details of a device
This call returns a list of installed apps on a device or a list of devices.
Required role
See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.
|
Required Role |
|
Category: Privacy Control Role Description: View apps in device details |
HTTP method
GET
Request URI
/api/v2/devices/appinventory
Request parameters
|
Parameter |
Description |
Sample Value |
|
adminDeviceSpaceId |
Required Parameter Type: Query Data Type: Number Device space ID of the administrator. |
1 |
|
deviceUuids |
Parameter Type: Query Data Type: String list Default: false Comma separated list of device uuids. Maximum combined number of 25 deviceUuids and wifiMacs. |
df5e84fa-ffc0-47d7-98c2-300a4ada396b |
|
wifiMacs |
Parameter Type: Query Data Type: String list Comma separated list of device wifi mac addresses. Maximum combined number of 25 deviceUuids and wifiMacs. |
AC3C0B79FED7 |
Response fields
|
Field |
Description |
|
messages |
Messages section |
|
type |
Message type |
|
messageKey |
Message key |
|
localizedMessage |
Localized message with parameters resolved |
|
results |
Array of device details follow |
|
deviceUuid |
Details for this device uuid |
|
appInventory |
List of device apps follows |
|
name |
Name of app installed on the device |
|
identifier |
App identifier |
|
version |
App version |
|
platformType |
App platform type |
|
status |
App status |
|
vpnName |
App vpn name |
|
configurations |
List of app connect configurations follow |
|
typeId |
Configuration type id |
|
clientId |
Device client id |
|
appId |
App identifier |
|
modifiedAt |
Timestamp of record modification |
|
appUuid |
App uuid |
|
agentUuid |
Agent uuid |
|
coreUuid |
Ivanti EPMM uuid |
|
name |
App connect name |
|
state |
State |
|
message |
If there is an app (appUuid), client (agentUuid) or config (coreUuid) mismatch then old equals “true”. Message will contain a description when old equals “true”. |
|
old |
If there is an app (appUuid), client (agentUuid) or config (coreUuid) mismatch then old equals “true”. Message will contain a description when old equals “true”. |
Sample request and response
Request
curl 'https://[Ivanti EPMM]/api/v2/devices/appinventory?adminDeviceSpaceId=1&deviceUuids=e2431389-d5db-48b5-aa12-dff52746a5a5' -H 'Authorization: Basic <token>'
Response
{
"results": [
{
"deviceUuid": "70e3fc6b-ee97-410d-a712-3bdbf8f004dd",
"appInventory": [
{
"name": "AllShare Cast Dongle S/W Update",
"identifier": "com.sec.android.fwupgrade",
"version": "1.2.3717",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Android for Work App",
"identifier": "com.google.android.apps.work.core",
"version": "2.0.1",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "ANT Radio Service",
"identifier": "com.dsi.ant.service.socket",
"version": "4.14.0",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "ANT+ Plugins Service",
"identifier": "com.dsi.ant.plugins.antplus",
"version": "3.6.0",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Appium Settings",
"identifier": "io.appium.settings",
"version": "1.0",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "AT&T Navigator",
"identifier": "com.telenav.app.android.cingular",
"version": "5.7.5.1.8421421",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "AT&T Protect Plus",
"identifier": "com.asurion.android.mobilerecovery.att",
"version": "8.76.4",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Beaming Service",
"identifier": "com.mobeam.barcodeService",
"version": "1.3.2 ",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Box",
"identifier": "com.box.android",
"version": "3.7.5",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "C646963",
"identifier": "com.testpackage.c646963",
"version": "1.0",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "C919229",
"identifier": "com.testpackage.c919229",
"version": "2.0",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Chrome",
"identifier": "com.android.chrome",
"version": "50.0.2661.89",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Drive",
"identifier": "com.google.android.apps.docs",
"version": "2.4.141.16.35",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Flipboard",
"identifier": "flipboard.app",
"version": "3.4.2",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Galaxy Apps",
"identifier": "com.sec.android.app.samsungapps",
"version": "4.1.04-9",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Google Play Books",
"identifier": "com.google.android.apps.books",
"version": "3.8.15",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Google Play Games",
"identifier": "com.google.android.play.games",
"version": "3.7.23 (2867637-038)",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Google Play Movies & TV",
"identifier": "com.google.android.videos",
"version": "3.13.10",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Google Play Music",
"identifier": "com.google.android.music",
"version": "6.7.2713Z.2790541",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Google Play services",
"identifier": "com.google.android.gms",
"version": "9.2.56 (038-124593566)",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Google Play Store",
"identifier": "com.android.vending",
"version": "6.7.13.E-all [0] 2920566",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Google Text-to-speech Engine",
"identifier": "com.google.android.tts",
"version": "3.8.16",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Google+",
"identifier": "com.google.android.apps.plus",
"version": "7.7.0.120011031",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Hangouts",
"identifier": "com.google.android.talk",
"version": "8.0.116581895",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "HP Print Service Plugin",
"identifier": "com.hp.android.printservice",
"version": "2.8-1.5.0-10e-16.1.16-71",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Keeper",
"identifier": "com.callpod.android_apps.keeper",
"version": "10.0.1",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Lookout",
"identifier": "com.lookout",
"version": "9.39.1-f7e5585",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Maps",
"identifier": "com.google.android.apps.maps",
"version": "9.23.1",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Mobile TV",
"identifier": "com.mobitv.client.tv",
"version": "6.0.main.84-3e70d92",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "MobileIron",
"identifier": "com.mobileiron",
"version": "9.0.1.0.68D",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Peel Smart Remote",
"identifier": "tv.peel.smartremote",
"version": "8.8.1",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Pulse Secure",
"identifier": "net.pulsesecure.pulsesecure",
"version": "5.2.3.65383",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "S Health",
"identifier": "com.sec.android.app.shealth",
"version": "4.7.2.0003",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Samsung Link Platform",
"identifier": "com.samsung.android.sdk.samsunglink",
"version": "2.0.2",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Samsung Print Service Plugin",
"identifier": "com.sec.app.samsungprintservice",
"version": "2.15.16011",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Samsung Push Service",
"identifier": "com.sec.spp.push",
"version": "1.6.00",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Security policy updates",
"identifier": "com.policydm",
"version": "SPD_v2_1409_2_1",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Softcard",
"identifier": "com.isis.mclient.atnt.activity",
"version": "3.0",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "System Info for Android",
"identifier": "com.electricsheep.asi",
"version": "1.26.2",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "TalkBack",
"identifier": "com.google.android.marvin.talkback",
"version": "4.4.1",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "TouchDown for SmartPhones",
"identifier": "com.nitrodesk.droid20.nitroid",
"version": "8.5.00094",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Unlock",
"identifier": "io.appium.unlock",
"version": "1.0",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "Vysor",
"identifier": "com.koushikdutta.vysor",
"version": "1.0.0.0",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "YouTube",
"identifier": "com.google.android.youtube",
"version": "11.13.56",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
},
{
"name": "YP",
"identifier": "com.yellowpages.android.ypmobile",
"version": "5.8.1",
"platformType": "A",
"status": null,
"vpnName": null,
"configurations": null
}
]
}
],
"messages": [
{
"type": "Info",
"messageKey": "com.mobileiron.vsp.messages.appstore.get.inventory.devices.success",
"localizedMessage": "\"Got app inventory for devices [70e3fc6b-ee97-410d-a712-3bdbf8f004dd].\""
}
]
}
Get devices that have a specific app installed
This call returns a list of devices that have a specific app installed.
Required Role
See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.
|
Required Role |
|
Category: App Management Role Description: View app inventory |
HTTP method
GET
Request URI
/api/v2/appinventory/devices
Request parameters
|
Parameter |
Description |
Sample Value |
|
adminDeviceSpaceId |
Required Parameter Type: Query Data Type: Number Device space ID of the administrator. |
1 |
|
inventoryId |
Required: One of inventoryId, appName ,or AppId is mandatory. Parameter Type: Query Data Type: Integer Use /appinventory/apps?summaryView=false to get InventoryID. |
14 |
|
appName |
Required: One of inventoryId, appName ,or AppId is mandatory. Parameter Type: Query Data Type: String The name of the app. |
Hangouts |
|
appId |
Required: One of inventoryId, appName ,or AppId is mandatory. Parameter Type: Query Data Type: String Bundle ID of the app. |
com.google.hangouts |
|
platformType |
Required; •Yes when appName or appId is used. •No when inventoryId is used. Parameter Type: Query Data Type: String Specifies from which platform to return installed apps. Default to return apps from all platforms. Valid values: I, A, M, E, Q •I = iOS •A = Android •M = Windows Phone •E = Windows 10 and Windows 8.1 •Q = Web Application |
A |
|
appDisplayVersion |
Parameter Type: Query Data Type: String Specifies the version of the app. |
5.1.20393 |
|
limit |
Parameter Type: Query Data Type: Number Min: 0 Indicates the maximum number of entries to return. Must be at least 0 and no more than 200. |
|
|
offset |
Parameter Type: Query Data Type: Number Min: 0 Max: 10,000,000 Default: 0 Indicates the index of the first entry to return. |
|
|
sortField |
Parameter Type: Query Data Type: String Valid Values: •phonenumber (device current phone number) •username (device user principal) •platform (device platform) •version (app inventory version) |
phonenumber |
|
sortOrder |
Parameter Type: Query Data Type: String Default: ASC Indicates the order in which entries are returned. Values can be "ASC" or "DESC". |
ASC |
Response fields
|
Field |
Description |
|
results |
An array of the following objects: uuid, id, principal, deviceSpaceId, deviceSpacePath, username, platform, os, phonenumber, model, version, name, managed, and vppAccountName. |
|
totalCount |
The total number of entries that the query matched. |
|
resultCount |
The number of entries that are being returned. |
|
hasMore |
Indicates that there are more entries available. |
Sample request and response
Request
curl -k -v -sS -u <userName>:<password> -XGET 'https://[Ivanti EPMM]/api/v2/appinventory/devices?adminDeviceSpaceId=1&inventoryId=14&sortField=username&sortOrder=ASC&page=1&offset=0&limit=50'
Response
{
"totalCount":2,
"resultCount":2,
"hasMore":false,
"results":[
{
"uuid":"a27d569a-33e0-4712-ab2f-10ec9d343fda",
"id":2,
"principal":"miadmin",
"deviceSpaceId":1,
"deviceSpacePath":"/1/",
"username":"miadmin",
"platform":"iOS 9.1",
"os":"I",
"phonenumber":"PDA 2",
"model":"iPad Mini",
"version":"8536168",
"name":"miadmin",
"managed":false,
"vppAccountName":null
},
{
"uuid":"526bc7a4-2d2e-4230-a766-05e94777c01d",
"id":1,
"principal":"miadmin",
"deviceSpaceId":1,
"deviceSpacePath":"/1/",
"username":"miadmin",
"platform":"iOS 9.1",
"os":"I",
"phonenumber":"15109348961",
"model":"iPhone 6 Plus",
"version":"8536168",
"name":"miadmin",
"managed":false,
"vppAccountName":null
}
]
}