Device Management

Search for devices

This call returns information about devices. There are three ways to get device information: filtered by a search query, filtered by label, or filtered by both a search query and a label. This call has a GDPR consideration. See GDPR Consideration.

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.

HTTP method

GET

Request URI

api/v2/devices

Request parameters

Supported queries

The following table describes the supported and unsupported query formats. Any deviation from the query formats noted as “supported” is unsupported.

Response fields

Sample request and response

Request

Search for smart phones with “Samsung” in their name.

{noformat}

curl 'https://[Ivanti EPMM]/admin/rest/api/v2/devices?count=50&offset=0&sortOrder=ASC&sortField=user.display_name&fields=user.display_name,common.current_phone_number,common.model,common.manufacturer,common.mdm_managed,common.platform_name,common.home_country_name,common.registration_date,common.last_connected_at,common.miclient_last_connected_at,common.owner,common.home_operator_name,common.language,common.creation_date,common.uuid,common.clientId,user.email_address,common.comment,user.user_id,common.storage_capacity,common.device_is_compromised,common.noncompliance_reasons,common.compliant,common.platform,common.quarantined,common.quarantined_reasons,common.id,android.attestation,ios.wakeup_status,common.status,common.device_space_name,common.background_status,common.data_protection_enabled,common.data_protection_reasons,common.device_admin_enabled,common.memory_capacity,common.memory_free,common.storage_capacity,common.storage_free,common.battery_level,common.client_name,common.client_version,ios.DataRoamingEnabled,common.locale,common.ethernet_mac,common.imei,common.imsi,common.ip_address,ios.iPhone ICCID,ios.iPhone MAC_ADDRESS_EN0,ios.iPhone UDID,ios.iPhone VERSION,ios.DeviceName,common.os_version,android.afw_capable,android.registration_status&labelId=-1&query=samsung&page=1&start=0&limit=50' -H 'authUserId: bWlhZG1pbg=='

{noformat}

Response

{

    "results": [

        {

            "common.ip_address": "10.11.103.146",

            "common.os_version": "4.4",

            "common.platform_name": "Android 4.4",

            "common.locale": "en-US",

            "common.storage_capacity": 11766960000,

            "common.miclient_last_connected_at": "2016-07-11T19:19:26.000Z",

            "common.home_operator_name": "AT&T",

            "common.uuid": "a57dcd91-f9a4-428e-bd47-3dd96bb7e1f9",

            "common.quarantined": false,

            "common.id": 9,

            "common.device_space_name": "Global",

            "common.ccm_migration_status": "None",

            "common.imsi": "310410792173128",

            "android.afw_capable": false,

            "common.storage_free": 9754620000,

            "common.device_is_compromised": false,

            "common.owner": "COMPANY",

            "user.email_address": "[email protected]",

            "common.manufacturer": "samsung",

            "common.data_protection_enabled": true,

            "common.mdm_managed": false,

            "common.memory_free": 615304396,

            "common.model": "SAMSUNG-SM-G900A",

            "common.memory_capacity": 1946943488,

            "common.client_name": "com.mobileiron",

            "common.status": "ACTIVE",

            "common.current_phone_number": "PDA",

            "common.platform": "Android",

            "common.imei": "354691065438150",

            "user.display_name": "testuser2264",

            "common.creation_date": "2016-07-11T19:18:13.000Z",

            "android.attestation": "Unknown",

            "common.background_status": 0,

            "common.last_connected_at": "2016-07-11T19:19:26.000Z",

            "common.home_country_name": "United States",

            "android.registration_status": "Device Admin",

            "common.battery_level": 100,

            "common.client_version": "9.0.1.0.68D",

            "common.language": "English",

            "user.user_id": "testuser2264",

            "common.compliant": true,

            "common.registration_date": "2016-07-11T19:19:26.000Z",

            "common.device_admin_enabled": true

        }

    ],

    "totalCount": 1,

    "resultCount": 1,

    "searchTimeMillis": 51,

    "currentServerTimeMilliseconds": 1468265055060,

    "hasMore": false

}

Self-register a device

This call enables a user to self-register a device on the user portal.

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.

HTTP method

POST

Request URI

api/v2/users/register_device

Request parameters

Response fields

Sample request

curl -kv -u username:password -H "Content-Type: application/json" --data '{"countryCode": 1, "deviceLanguageId": 1, "isForceRegister": "false", "isPhoneNumberAvailable": "true", "notifyUser": "true", "operatorId": 269, "phoneNumber": "4083338888", "platform": "I"}' -XPOST 'https://[Ivanti EPMM]/api/v2/users/register_device';

Sample response

 {
	"results": [
		{
		"passcode": "600698",
		"ttl": "120",
		"regLink": "http://[Ivanti EPMM]:8080/mifs/c/d/ios.html",
		"email": "[email protected]"
		}
	],
	"totalCount": 1,
	"resultCount": 1
}

Act on a device

This call performs one of the following actions on a device:

•ENABLE_VOICE_ROAMING (iOS)

•DISABLE_VOICE_ROAMING (iOS)

•ENABLE_DATA_ROAMING (iOS)

•DISABLE_DATA_ROAMING (iOS)

•ENABLE_PERSONAL_HOTSPOT (iOS)

•DISABLE_PERSONAL_HOTSPOT (iOS)

•SEND_MESSAGE (Android, iOS)

•UPDATE_OS (iOS)

•UNLOCK_APP_CONNECT_CONTAINER (Android)

•UNLOCK_DEVICE_ONLY (Android, iOS)

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.

HTTP method

POST

Request URI

api/v2/devices/action

Request parameters

Additional request parameters for send_message

Response fields

Sample request and response

Request

Enable data roaming.

curl -k -sS -u <userName>:<password> -v -XPOST 'https://[Ivanti EPMM]/api/v2/devices/action?adminDeviceSpaceId=1&actionType=ENABLE_VOICE_ROAMING' -d '{ "deviceUuids": ["a2556e62-2ed0-4d42-98fd-a342eaf3e4e6","aa0a05dc-14c9-4355-9640-406b5c219c06","d427879e-bdce-469a-810e-d38eef39bf8e"], "note" : "sample note" }' -H 'Content-Type:application/json'

Response

{

    "actionType": "ENABLE_VOICE_ROAMING",

    "deviceResults": {

        "a68bb0cf-7a35-4d52-8259-c83398a41160": "com.mobileiron.vsp.messages.device.action.successful"

    },

    "successful": true

}

Request

Send message

curl -k -sS -u <userName>:<password> -v -XPOST 'https://[Ivanti EPMM]/api/v2/devices/action?adminDeviceSpaceId=1&actionType=SEND_MESSAGE' -d '{ "deviceUuids": ["db46d2ca-df92-46d6-807e-8eb014e28a6f"], "note" : "Alerting owner to policy violation.", "additionalParameters" : {"message" : "Your device is in policy violation","mode" : "sms","subject":"Important news about your device","app" : "Motorola MC75"} }' -H 'Content-Type:application/json'

Response

{

"actionType"": ""SEND_MESSAGE"

"deviceResults"": {

"db46d2ca-df92-46d6-807e-8eb014e28a6f"": ""com.mobileiron.vsp.messages.device.action.successful""

}-

"successful"": true

}

Export devices

This call returns a CSV file for all devices found by the search. Use the fieldGroups parameter to specify a list of field groups to be returned in the CSV file.

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.

HTTP method

POST

Request URI

api/v2/devices

Request parameters

Response values

Content-Type: text/csv

Content-Disposition: attachment; filename= DeviceSearchResult.csv

Sample request and response

Request

curl "https://[Ivanti EPMM]/api/v2/devices?fieldGroups=USER"%"2CCOMMON"%"2CANDROID"%"2CIOS"%"2CWINDOWS_PHONE&labelId=-10&query=" -H "Content-type: application/json" --data "authUserId=bWlhZG1pbg"%"3D"%"3D"

Response

Response is a CSV file containing the retrieved values.

Delete devices

This call deletes retired iOS, OS X, Win8, or Android devices that have not been modified in the last day.

Required Role

HTTP method

DELETE

Request URI

api/v2/devices

Request parameters

Response object

A JSON object containing the following fields:

Sample request and response

Request

curl -k -sS -u username:password -XDELETE -H "Content-Type: application/json" 'https://[Ivanti EPMM]/api/v2/devices?adminDeviceSpaceId=1' -d '{ "deviceUuids" : [ "10c43352-15b2-413b-a3e0-4daf3977711a", "B0BAB9BA-388E-4612-B579-43A40411670C" ] }'

Response

Only the first UUID was returned because it met the criteria for deletion. The second UUID was not deleted, either because it was not retired, it had been modified within the last day, or it was not of the correct platform.

[

    "10c43352-15b2-413b-a3e0-4daf3977711a"

]

Count devices

This call returns the count of devices that match the specified query.

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.

HTTP method

GET

Request URI

api/v2/devices/count

Request parameters

Response fields

Sample request and response

Request

Count all devices that are manufactured by Apple.

curl -X GET -H "Authorization: Basic <token>" https://[Ivanti EPMM]]/api/v2/devices/count?adminDeviceSpaceId=1&query="common.manufacturer" starts with "Appl"

Response

{

    "totalCount": 117

}

Test an advanced search query

This call tests that the device-search query parses correctly.

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.

HTTP method

GET

Request URI

api/v2/devices/query_test

Request parameters

Response fields

Sample request and response

Request

Validate the query.

curl -G -k -sS -u username:password 'https://[Ivanti EPMM]/api/v2/device/query_test' --data 'query%3Dmanufacturer%20contains%20%22blargle%22'

Response

{

    "valid": false,

    "token": "blargle",

    "position": 21

}

Get the list of searchable device fields

This call gets the name and type of device, details, and LDAP fields. You can use this information to find values for the fields parameter for any of the API calls that allow specification of search fields, such as Search for 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.

HTTP method

GET

Request URI

api/v2/devices/search_fields

Request parameters

Response fields

An array of field-name-to-data-type objects:

Sample request and response

Request

Get the fields.

curl -G -k -sS -u username:password 'https://[Ivanti EPMM]/api/v2/device/search_fields'

Response

[

        { "name" : "uuid", "type" : "STRING" },

        { "name" : "block_reason", "type" : "NUMBER" },

        { "name" : "last_connected_at", "type" : "DATE" },

        { "name" : "details.APNS Capable", "type" : "STRING" },

        { "name" : "ldap.user.baseDn", "type" : "STRING" }

]

Get device details

This call gets device details for a specific device.

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.

HTTP method

GET

Request URI

api/v2/devices/<deviceId>/details

Request parameters

Response fields

Sample request and response

Request

curl "https://[Ivanti EPMM]/api/v2/devices/2e33329d-fed5-4f56-a2b7-65caa5ef0cfe/details -H "authUserId: username" -H "Accept: application/json"

Response

{

    results: [

        {

            name: "ios.ProductName",

            value: null

        },

        {

            name: "common.current_operator_name",

            value: null

        },

        {

            name: "ios.security_reason_code",

            value: "0x00000008"

        },

        {

            name: "common.registration_imsi",

            value: "310410"

        },

       ... {

            name: "ios.BluetoothMAC",

            value: null

        },

        {

            name: "ios.IsDeviceLocatorServiceEnabled",

            value: false

        }

    ],

    totalCount: 84,

    resultCount: 84

}

Include battery health information in Android device details

This call includes battery health information in Android device details.

Additional battery health statistics per-device includes:

• Android Battery Charging Status

• Android Battery Health Status

• Battery Charge Cycles (OEM)*

• Battery Health Percentage (OEM)*

• Battery Manufacture Date (OEM)*

*The OEM fields only populate if the device is a Zebra device.

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.

HTTP method

GET

Request URI

api/v2/devices/<deviceId>/details?command=deviceDetail&deviceId=<deviceId>&os=<os version>&isBatteryStatsRequired=[true|false]

Request parameters

Response fields

Sample request and response

Request

https://[Ivanti EPMM]/api/v2/devices/9af85060-4775-4f52-967c-bfb4979bd19d/details?command=deviceDetail&deviceId=9af85060-4775-4f52-967c-bfb4979bd19d&os=Android%2012L&isBatteryStatsRequired=true

Response

{ "results": [ { "name": "android.wifi_inventory_mac_addr", "value": null }, { "name": "common.locale", "value": "en-US" }, { "name": "android.zebra_build_id", "value": null }, { "name": "common.sd_card_encrypted", "value": false }, { "name": "common.client_id", "value": 1073741834 }, { "name": "android.battery_zebra_total_cumulative_charge", "value": null }, { "name": "android.battery_zebra_bkvoltage", "value": null }, { "name": "android.battery_zebra_seconds_since_first_use", "value": null }, { "name": "common.imsi", "value": "" }, { "name": "android.afw_capable", "value": true }, { "name": "android.admin_activated", "value": true }, { "name": "common.mdm_managed", "value": false }, { "name": "android.secure_apps_encryption_enabled", "value": false }, { "name": "android.platform_flags", "value": "0x143" }, { "name": "android.battery_zebra_health_percentage", "value": null }, { "name": "common.creation_date", "value": "2022-07-05T07:34:05.000Z" }, { "name": "common.background_status", "value": 0 }, { "name": "common.EnhancedLoggingEnabled", "value": false }, { "name": "android.android_automated_enrollment", "value": "Unknown" }, { "name": "common.last_connected_at", "value": "2022-07-05T07:45:27.000Z" }, { "name": "android.battery_zebra_partnumber", "value": null }, { "name": "android.battery_health", "value": null }, { "name": "android.mdm_enabled", "value": true }, { "name": "android.battery_zebra_time_to_full", "value": null }, { "name": "android.codename", "value": null }, { "name": "common.client_version", "value": "11.6.0.1.1R" }, { "name": "common.ethernet_mac", "value": null }, { "name": "common.mtd_status", "value": "N/A" }, { "name": "android.battery_zebra_ratedcapacity", "value": null }, { "name": "android.prv_enable_network_slicing", "value": false }, { "name": "android.os_build_number", "value": "SQ3A.220605.009.B1" }, { "name": "android.security_detail", "value": "0" }, { "name": "android.multi_mdm", "value": false }, { "name": "common.device_admin_enabled", "value": true }, { "name": "common.location_last_captured_at", "value": null }, { "name": "common.os_version", "value": "12L" }, { "name": "common.intune_compliance_azure_tenant_id", "value": null }, { "name": "common.mdm_tos_accepted_date", "value": null }, { "name": "android.safety_net_status", "value": "None" }, { "name": "common.uuid", "value": "9af85060-4775-4f52-967c-bfb4979bd19d" }, { "name": "android.samsung_carrier_code", "value": null }, { "name": "android.secure_apps_encryption_mode", "value": null }, { "name": "common.display_size", "value": "2240X1080" }, { "name": "android.aosp_device", "value": "no" }, { "name": "android.iccid", "value": "" }, { "name": "common.device_is_compromised", "value": false }, { "name": "user.email_address", "value": null }, { "name": "android.safety_net_timestamp", "value": null }, { "name": "android.dualdar_enabled", "value": false }, { "name": "android.brand", "value": "google" }, { "name": "android.battery_status", "value": null }, { "name": "common.client_name", "value": "com.mobileiron" }, { "name": "common.imei", "value": "" }, { "name": "android.os_update_status", "value": null }, { "name": "user.last_name", "value": null }, { "name": "user.display_name", "value": "miadmin" }, { "name": "android.zebra_patch_version", "value": null }, { "name": "android.file_encryption", "value": true }, { "name": "android.developer_mode", "value": false }, { "name": "android.safety_net_result_exception", "value": "" }, { "name": "android.zebra_artifact_fingerprint", "value": null }, { "name": "common.registration_imsi", "value": null }, { "name": "android.manufacturer_os_version", "value": "12" }, { "name": "android.battery_zebra_time_to_empty", "value": null }, { "name": "user.uuid", "value": "bc4202db-ae47-4963-b207-24157b3a5df8" }, { "name": "android.battery_zebra_present_capacity", "value": null }, { "name": "android.usb_debugging", "value": false }, { "name": "android.battery_zebra_decommission", "value": null }, { "name": "common.mdm_tos_accepted", "value": false }, { "name": "common.ip_address", "value": "192.168.0.8" }, { "name": "android.media_card_capacity", "value": null }, { "name": "android.screenlock_pin_change_prompt", "value": "false" }, { "name": "common.mtd_anti_phishing_status", "value": "N/A" }, { "name": "common.client_build_date", "value": "2022-04-07T21:31:41.000Z" }, { "name": "android.security_patch_date", "value": "2022-06-05T00:00:00.000Z" }, { "name": "user.first_name", "value": null }, { "name": "common.intune_compliance_azure_device_compliance_status", "value": null }, { "name": "common.current_operator_name", "value": null }, { "name": "android.battery_zebra_base_cumulative_charge", "value": null }, { "name": "android.samsung_model_number", "value": null }, { "name": "android.device", "value": "oriole" }, { "name": "android.battery_zebra_serialnumber", "value": null }, { "name": "common.wifi_mac_address", "value": "6a:02:39:cb:58:13" }, { "name": "user.sam_account_name", "value": null }, { "name": "common.mtd_anti_phishing_vpn_status", "value": "N/A" }, { "name": "common.intune_compliance_azure_client_status_code", "value": "Not supported" }, { "name": "android.bulk_enrollment_profile", "value": null }, { "name": "common.intune_compliance_azure_device_report_time", "value": null }, { "name": "common.device_encrypted", "value": true }, { "name": "android.zebra_ota_capable", "value": false }, { "name": "android.dualdar_version", "value": null }, { "name": "android.security_patch", "value": "2022-06-05" }, { "name": "common.location", "value": null }, { "name": "android.battery_zebra_mfd", "value": null }, { "name": "common.memory_capacity", "value": 7775075696 }, { "name": "common.security_state", "value": "Ok" }, { "name": "common.intune_compliance_azure_device_id", "value": null }, { "name": "android.attestation", "value": "Unknown" }, { "name": "common.registration_uuid", "value": "7ca11b9157a5ac80" }, { "name": "common.appconnect_tos_accepted", "value": null }, { "name": "android.registration_status", "value": "Work Profile" }, { "name": "android.incremental", "value": "8650216" }, { "name": "android.dpm_encryption_status", "value": "ACTIVE PER USER" }, { "name": "common.model_name", "value": null }, { "name": "android.media_card_free", "value": null }, { "name": "android.zebra_system_update_information", "value": null }, { "name": "android.safety_net_enabled", "value": false }, { "name": "android.samsung_dm", "value": null }, { "name": "android.battery_zebra_usage_numb", "value": null }, { "name": "android.kiosk_enabled", "value": false }, { "name": "common.registration_date", "value": "2022-07-05T07:34:05.000Z" }, { "name": "android.Client_version_code", "value": 652 }, { "name": "android.secure_apps_enabled", "value": false }, { "name": "android.prv_password_expiration_timeout", "value": 0 }, { "name": "common.storage_capacity", "value": 128000000000 }, { "name": "android.security_reason", "value": "" }, { "name": "common.miclient_last_connected_at", "value": "2022-07-05T07:45:27.000Z" }, { "name": "android.gcmToken", "value": true }, { "name": "android.os_update_path", "value": null }, { "name": "android.knox_version", "value": "" }, { "name": "android.c2dmToken", "value": null }, { "name": "android.efota_capable", "value": false }, { "name": "common.storage_free", "value": 111821280000 }, { "name": "common.intune_compliance_azure_device_compliance_report_status", "value": null }, { "name": "android.battery_zebra_present_charge", "value": null }, { "name": "common.manufacturer", "value": "Google" }, { "name": "android.device_roaming_flag", "value": "Not Available" }, { "name": "common.roaming", "value": false }, { "name": "common.memory_free", "value": 3813408768 }, { "name": "common.model", "value": "Pixel 6" }, { "name": "android.watch_app_installed", "value": false }, { "name": "common.apns_capable", "value": false }, { "name": "android.wear_paired", "value": false }, { "name": "common.cellular_technology", "value": "none" }, { "name": "common.battery_level", "value": 95 }, { "name": "common.enrollment_id", "value": "DFIQ-TWHE-GHZ7-5MOIN-LL3P-AHPO-T" }, { "name": "common.auth_only", "value": false }, { "name": "android.device_up_time", "value": 18 }, { "name": "android.google_device_account", "value": false }, { "name": "common.SerialNumber", "value": null }, { "name": "common.appconnect_tos_accepted_date", "value": null }, { "name": "common.processor_architecture", "value": null }, { "name": "user.user_id", "value": "miadmin" } ], "totalCount": 143, "resultCount": 143 }

Get Embedded Identity Document (EID) details

This call gets the EID information for the built-in Subscriber Identity Modules/Subscriber Identification Modules (SIMs) of iOS 14 and later 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.

HTTP method

GET

Request URI

/api/v2/devices/simdetails/{deviceId}?adminDeviceSpaceId={adminDeviceSpaceId}

Request parameters

Response fields

Sample request and response

Request

curl --location --request GET 'https://[Ivanti EPMM]/api/v2/devices/simdetails/dd8adade-4d26-4aad-96cc-0cc317692aeb?adminDeviceSpaceId=1' \

--header 'Accept: application/json, text/plain, */*' \

--header 'Content-Type: application/json' \

--header 'Authorization: Basic <token>' \

Response

{

    "results": [

        {

            "eid": "N/A",

            "phoneNumber": "N/A",

            "carrierSettingVersion": "N/A",

            "carrierNetwork": "N/A",

            "slot": "CTSubscriptionSlotOne",

            "simLabel": "N/A"

        },

        {

            "eid": "89049032005008882600048285696082",

            "phoneNumber": "+14089660949",

            "carrierSettingVersion": "41.7.70",

            "carrierNetwork": "Verizon ",

            "slot": "CTSubscriptionSlotTwo",

            "simLabel": "Secondary"

        }

    ],

    "totalCount": 2,

    "resultCount": 2

}

Get Last Sync Time and State of ActiveSync Devices

This call gets the sync time and state of ActiveSync devices. The CSV output of this call is a helpful reference for operators who retire devices from Ivanti EPMM and need to remove the same devices from the ActiveSync profile on Microsoft Exchange. For example, an admin could create PowerShell scripts to read the response of this call and delete devices from the ActiveSync profile on Microsoft Exchange that have not synced in a week.

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.

HTTP method

GET

Request URI

api/V2/activesync/devicereport?daysIdle=0&state=a

Request parameters

Response fields

This call returns information about ActiveSync devices matching search criteria in the HTTP response body in CSV format. The first line is the CSV column header line, followed by the actual ActiceSync device data, one row per ActiveSync device.

Sample request and response

Request

curl -X GET -H "Authorization: Basic <token>" https://[Ivanti EPMM]/api/v2/activesync/devicereport/?daysIdle=0&state=A

Response

DeviceId,MailboxId,Status,SyncStatus,Retired,LastSyncTime,SentryType

DeviceID-1,[email protected],Unregistered,Allowed,false,2015-03-30 03:14:57 GMT,Standalone

DeviceID-2,[email protected],Registered,Blocked,false,2015-03-31 03:14:57 GMT,Integrated

DeviceID-3,[email protected],Unregistered,Unknown,true,2015-04-01 03:14:57 GMT,Integrated

Get app control compliance information for a device

This call gets app control compliance information for a device.

Required Roles

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.

HTTP method

GET

Request URI

api/v2/devices/<deviceUuid>/appcompliance

Request parameters

Response fields

Sample request and response

Request

curl -k -sS -u <userName>:<password> -XGET 'https://[Ivanti EPMM]/api/v2/devices/7b3ad194-3bc0-4229-b30f-26f6bb277dd7/appcompliance?adminDeviceSpaceId=1'

Response

{

    "results": {

        "deviceUuid": "7b3ad194-3bc0-4229-b30f-26f6bb277dd7",

        "appViolationsByType": {

            "Disallowed": [

                {

                    "type": "Disallowed",

                    "appName": "Sudoku",

                    "appVersion": "4.6"

                }

            ],

            "Required": [

                {

                    "type": "Required",

                    "appName": "Evernote",

                    "appVersion": null

                },

                {

                    "type": "Required",

                    "appName": "Waze",

                    "appVersion": null

                }

            ]

        }

    }

}

Wake up a device

This call wakes up a device by requiring it to check in.

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.

HTTP method

PUT

Request URI

api/v2/devices/wakeup

Request parameters

Response fields

Sample request and response

Request

curl --user <username>:<password> --header 'Content-Type: application/json' --request PUT 'https://[Ivanti EPMM]/api/v2/devices/wakeup?adminDeviceSpaceId=1' --data '{"deviceUuids": ["af0cea8b-f56c-49f5-b615-76cc34936b2f"], "note": "something"}'

Response

{

    "actionType": "WAKEUP_DEVICE",

    "deviceResults": {

        "af0cea8b-f56c-49f5-b615-76cc34936b2f": "com.mobileiron.vsp.messages.device.action.successful"

    },

    "successful": true

}

Send message

This call sends a message to devices with the specified deviceUuids.

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.

HTTP method

PUT

Request URI

api/v2/devices/sendmessage

Request parameters

Response fields

Sample request and response

Request

curl --user <username>:<password> --header 'Content-Type: application/json' --request PUT 'https://[Ivanti EPMM]/api/v2/devices/sendmessage?adminDeviceSpaceId=1' --data '{"deviceUuids": ["30b8b722-2954-42ab-bda8-700facfa249a"], "note": "Alerting to data roaming expense.", "additionalParameters": {"message" : "Data roaming is expensive.", "mode": "email", "subject" : "About data roaming”} }'

Response

{

    "results": [

        {

            "resultId": "114",

            "resultMessage": null,

            "records": [

                "30b8b722-2954-42ab-bda8-700facfa249a"

            ]

        }

    ],

    "resultCount": 1,

    "actionType": "SEND_MESSAGE",

    "deviceResults": {

        "30b8b722-2954-42ab-bda8-700facfa249a": "com.mobileiron.vsp.messages.device.action.successful"

    },

    "successful": true

}

Apply labels to devices

This call applies labels to 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.

HTTP method

PUT

Request URI

api/v2/devices/labels/label1,label2/add

Request parameters

Response fields

Sample request and response

Request

ccurl  --user <username>:<password> --header 'Content-Type: application/json' --request PUT 'https://[Ivanti EPMM]/api/v2/devices/labels/ios,company-owned/add?adminDeviceSpaceId=1' --data '{"deviceUuids": ["af0cea8b-f56c-49f5-b615-76cc34936b2f"]}'

Response

{

    "results": [

        {

            "resultId": "114",

            "resultMessage": null,

            "records": [

                {

                    "uuid": null,

                    "id": null,

                    "principal": null,

                    "deviceSpaceId": 1,

                    "deviceSpacePath": "/1/",

                    "label": "ios",

                    "device": [

                        {

                            "uuid": "9a56d1e5-ca74-4776-868c-389c849348b2"

                        }

                    ]

                },

                {

                    "uuid": null,

                    "id": null,

                    "principal": null,

                    "deviceSpaceId": 1,

                    "deviceSpacePath": "/1/",

                    "label": "company-owned",

                    "device": [

                        {

                            "uuid": "9a56d1e5-ca74-4776-868c-389c849348b2"

                        }

                    ]

                }

            ]

        }

    ],

    "resultCount": 1,

    "actionType": "APPLY_LABEL_TO_DEVICES",

    "deviceResults": { },

    "successful": true

}

Remove labels from devices

This call removes labels from 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.

HTTP method

PUT

Request URI

api/v2/devices/labels/label1,label2/remove

Request parameters

Response fields

Sample request and response

Request

curl --user <username>:<password> --header 'Content-Type: application/json' --request PUT 'https://[Ivanti EPMM]/api/v2/devices/labels/ios,company-owned/remove?adminDeviceSpaceId=1' --data '{"deviceUuids": ["af0cea8b-f56c-49f5-b615-76cc34936b2f"]}'

Response

{

    "results": [

        {

            "resultId": "114",

            "resultMessage": null,

            "records": [

                {

                    "uuid": null,

                    "id": null,

                    "principal": null,

                    "deviceSpaceId": 1,

                    "deviceSpacePath": "/1/",

                    "label": "ios",

                    "device": [

                        {

                            "uuid": "9a56d1e5-ca74-4776-868c-389c849348b2"

                        }

                    ]

                },

                {

                    "uuid": null,

                    "id": null,

                    "principal": null,

                    "deviceSpaceId": 1,

                    "deviceSpacePath": "/1/",

                    "label": "company-owned",

                    "device": [

                        {

                            "uuid": "9a56d1e5-ca74-4776-868c-389c849348b2"

                        }

                    ]

                }

            ]

        }

    ],

    "resultCount": 1,

    "actionType": "REMOVE_LABEL_FROM_DEVICES",

    "deviceResults": { },

    "successful": true

}

Wipe devices

This call wipes 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.

HTTP method

PUT

Request URI

api/v2/devices/wipe

Request parameters

{
    "deviceUuids": [
        "cb1bcc55-bba3-41df-9efa-a3496b065bf9"
    ], 
     
    "additionalParameters": {
        "preserveDataPlan": "true"

     "sendWipeNotification": "false"
    }
}

Response fields

Sample request and response

Request

curl --location --request PUT 'https://[Ivanti EPMM]/api/v2/devices/wipe?adminDeviceSpaceId=1' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic <token>' \ --data '{"deviceUuids": ["cb1bcc55-bba3-41df-9efa-a3496b065bf9"], "note": "Employee left company.", "additionalParameters": {"preserveDataPlan": "true"}}'

Response

{ "results": [ { "resultId": "114", "resultMessage": null, "records": [ "cb1bcc55-bba3-41df-9efa-a3496b065bf9" ] } ], "resultCount": 1, "actionType": "WIPE", "deviceResults": { "cb1bcc55-bba3-41df-9efa-a3496b065bf9": "com.mobileiron.vsp.messages.device.action.successful" }, "successful": true }

Lock devices

This call locks 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.

HTTP method

PUT

Request URI

api/v2/devices/lock

Request parameters

Response fields

Sample request and response

Request

curl --user <username>:<password> --header 'Content-Type: application/json' --request PUT 'https://[Ivanti EPMM]/api/v2/devices/lock?adminDeviceSpaceId=1' --data '{"deviceUuids": ["af0cea8b-f56c-49f5-b615-76cc34936b2f"], "note": "Employee left company."}'

Response

{

    "actionType": "LOCK",

    "deviceResults": {

        "af0cea8b-f56c-49f5-b615-76cc34936b2f": "com.mobileiron.vsp.messages.device.action.successful"

    },

    "successful": true

}

Unock devices

This call unlocks 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.

HTTP method

PUT

Request URI

api/v2/devices/unlock

Request parameters

Response fields

Sample request and response

Request

curl --user <username>:<password> --header 'Content-Type: application/json' --request PUT 'https://[Ivanti EPMM]/api/v2/devices/unlock?adminDeviceSpaceId=1' --data '{"deviceUuids": ["af0cea8b-f56c-49f5-b615-76cc34936b2f"], "note": "Virus scan successful."}'

Response

{

    "actionType": "UNLOCK",

    "deviceResults": {

        "af0cea8b-f56c-49f5-b615-76cc34936b2f": "com.mobileiron.vsp.messages.device.action.successful"

    },

    "successful": true

}

Retire devices

This call retires 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.

HTTP method

PUT

Request URI

api/v2/devices/retire

Request parameters

Response fields

Sample request and response

Request

curl --user miadmin:<password> --header 'Content-Type: application/json' --request PUT 'https://[Ivanti EPMM]/api/v2/devices/retire?adminDeviceSpaceId=1' --data '{"deviceUuids": ["e4dd5f15-0349-49a9-9cc7-0e6d121ff229","7f2f9390-4593-4351-b065-6409016026be"], "note": "New phone issued", "additionalParameters":{"isActionForced":true}}'

Response

{
    "results": [
        {
            "resultId": "114", 
            "resultMessage": null, 
            "records": [
                "754ee0ba-a2f3-4f45-814e-fcfe230665f7"
            ]
        }
    ], 
    "resultCount": 1, 
    "actionType": "RETIRE", 
    "deviceResults": {
        "754ee0ba-a2f3-4f45-814e-fcfe230665f7": "com.mobileiron.vsp.messages.device.action.successful"
    }, 
    "successful": true
}

Open TeamViewer session

This call opens a TeamViewer session for an Android or iOS device. The support engineer opens the supporter link in the return in a browser to initiate the Remote Display session.

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.

HTTP method

POST

Request URI

msa/v2/remote/[create_teamviewer_session_android|create_teamviewer_session_ios]

Request parameters

Response fields

Sample requests and response

Requests

Android

curl -v -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic <token>" -X POST https://[Ivanti EPMM]/msa/v2/remote/create_teamviewer_session_android -d "adminDeviceSpaceId=1&deviceUUID=2493c9a5-a9c8-43cb-af4c-9475dac8ba69"

iOS

curl -v -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic <token>" -X POST https://[Ivanti EPMM]/msa/v2/remote/create_teamviewer_session_ios -d "adminDeviceSpaceId=1&deviceUUID=8af2f758-15c4-4394-ac67-3729e3dfe2d0"

Response

{

    "results": {

        "httpStatus": "OK",

        "error": null,

        "error_description": null,

        "error_code": null,

        "error_signature": null,

        "code": "s35-924-946",

        "state": "Open",

        "groupid": "g86972161",

        "end_customer": null,

        "description": null,

        "assigned_userid": "u75347768",

        "end_customer_link": "https://get.teamviewer.com/s35924946",

        "supporter_link": "[https://get.teamviewer.com/s35924946-9c0G78d8rMMZ]",

        "valid_until": "2019-04-10T01:46:06Z"

    },

    "messages": [

        {

            "type": "Info",

            "messageKey": "com.mobileiron.vsp.messages.teamviewer.create.session",

            "localizedMessage": "Created TeamViewer session code"

        }

    ]

}

Check device compliance

This call checks device compliance for selected or all 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.

HTTP method

PUT

Request URI

api/v2/devices/checkcompliance

Request parameters

Response fields

Sample requests and response

Requests

Check Compliance for specific devices

curl --user <username>:<password> --header 'Content-Type: application/json' --request PUT 'https://[Ivanti EPMM]/api/v2/devices/checkcompliance?adminDeviceSpaceId=1&allDevices=false' --data '{"deviceUuids": ["af0cea8b-f56c-49f5-b615-76cc34936b2f"]}'

Check Compliance for all devices

curl --user <username>:<password> --header 'Content-Type: application/json' --request PUT 'https://[Ivanti EPMM]/api/v2/devices/checkcompliance?adminDeviceSpaceId=1&allDevices=true' --data '{}'

Response

{

    "results": [

        {

            "resultId": "114",

            "resultMessage": null,

            "records": [

                "af0cea8b-f56c-49f5-b615-76cc34936b2f"

            ]

        }

    ],

    "resultCount": 1,

    "actionType": "CHECK_COMPLIANCE",

    "deviceResults": {},

    "successful": true

}

Get device compliance and reason for non compliance

This call checks device compliance for the device specified with the deviceUuid parameter, and returns reasons for non-compliance, if present.

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.

HTTP method

GET

Request URI

/api/v2/devices/{deviceUuid}/rulecompliance

Request parameters

Response fields

Sample request

curl -X GET -u <username>:<password> -H 'Content-Type: application/json' 'https://[Ivanti EPMM]/api/v2/devices/9c311225-a7e1-486b-8682-96f96bfb38be/rulecompliance?adminDeviceSpaceId=1'

Sample response

{

    "results": [

        {

            "id": 1,

            "deviceUuid": "9c311225-a7e1-486b-8682-96f96bfb38be",

            "ruleId": 1,

            "complianceAction": 1,

            "quarantineAction": 0,

            "createdAt": 1558738202000,

            "userDisplayName": "miadmin",

            "userId": "miadmin",

            "platformName": "iOS 11.2",

            "model": "iPhone 6s",

            "actionName": "Send Alert",

            "ruleName": "test2",

            "complianceActionNames": [

                "ALERT"

            ]

        }

    ],

    "totalCount": 1,

    "resultCount": 1

}