We're excited to announce the general availability of the Sophos Mobile API. This API lets customers manage their devices enrolled with Sophos Mobile, and is particularly useful for customers who want to integrate with existing workflows or 3rd party tools.
Using the API
Sophos Central admins must set up API credentials to use the Sophos Mobile API. For details on setting up API credentials please see the Getting Started guide. Customers can then use tools such as Postman or curl to run API commands.
Once set up, admins can query for information about mobile devices and perform actions. This includes details such as listing device users, the last time a device synced, the OS version or compliance status. Admins can trigger a sync command to devices as well as sending a message to a user.
Examples
Device details
To get information about a tenant's mobile devices, use:
GET /mobile/v1/devices/{id}?view=full
This returns details like the below:
{
"id": "dd40830b-b103-4f9a-ae02-bbf0d792466d", //ID of the mobile device
"tenant": {
"id": "b8a75c7d-7492-4009-9f95-8c815551dc55" //Tenant of the mobile device
},
"name": "Chromebook 2687", //Name of the mobile device
"description": "", //A description for the mobile device
"phoneNumber": "", //The device's phone number configured in Sophos Mobile, if available
"email": "user@example.com", //Email of the user assigned to the device
"assignedPerson": {
"id": "9f059011-84c7-4849-ae2e-d0563743e485", //ID of the assigned user
"name": "Simon Smith", //Name of the assigned user
"email": "user@example.com" //Email of the assigned user
},
"healthState": {
"state": "amber", //Health statuts of the mobile device
"mode": "automatic" //Health statuts mode of the mobile device
},
"ownershipType": "corporate", //Ownership Type indicates it's a company issued device
"createdAt": "2024-10-15T14:18:50.000Z", //Timestamp the mobile device was created in the system
"updatedAt": "2024-10-15T14:57:15.000Z", //Timestamp the mobile device was updated
"lastSeenAt": "2024-10-24T05:35:30.000Z", //Timestamp the device connected to the server
"ixmAppLastSeenAt": "2024-10-24T05:35:30.000Z", //Timestamp the IXM app connected to the server
"compliance": {
"compliant": false, //Mobile device isn't compliant
"severity": "high" //The severity of the compliance violation is high
},
"modelName": "Google Chromebook", //The model name of the mobile device
"managementType": "chromeSecurity", //The mobile device is only managed by the Chrome Security Extension
"managedState": "managed", //The management state of the mobile device
"os": {
"id": "4e880043-3206-4166-ab0b-3d9bf2a60196", //The ID of this OS entry
"name": "Chrome 129", //Name of the OS entry
"platform": "chrome" //Platform of the OS entry
},
"deviceGroup": {
"id": "47641750-7f17-461a-84c2-8e94fd705b20", //The device group ID
"name": "Default" //The device group name
}
}
Run a scan
Intercept X for Mobile scans Android devices for malware. To trigger a malware scan use:
POST /mobile/v1/actions/scan
In the request include the devices to be scanned:
{
"endpoints": [ //A list of endpoints which should execute a scan
"dd40830b-b103-4f9a-ae02-bbf0d792466d",
"e7e88612-d9b1-4e2f-b248-f2fad48579e4"
]
}
More Information
The Mobile API Guide has additional examples, and the full details are available on the API reference page.
