Mobile API¶
Query mobile devices belonging to a tenant, and perform routine actions on them.
See the guide for a narrative walkthrough of this API.
Base URL¶
https://api-{dataRegion}.central.sophos.com/mobile/v1 — Regional service in the production environment.
| Variable | Description | Default | Allowed values |
|---|---|---|---|
dataRegion | The tenant's data region. | eu01 | eu01, eu02, us01, us03 |
Authentication¶
Every request carries an Authorization: Bearer header with an access token obtained through the client-credentials flow — see Get started.
Operations¶
Actions¶
- Get list of actions
GET/actions - Get logs action
POST/actions/get-logs - Locate action
POST/actions/locate - Lock action
POST/actions/lock - Scan action
POST/actions/scan - Send Message action
POST/actions/send-message - Sync action
POST/actions/sync - Unenroll action
POST/actions/unenroll - Wipe action
POST/actions/wipe - Get action by ID
GET/actions/{id} - Delete action
DELETE/actions/{id}
AppGroups¶
- List app groups
GET/app-groups - Create app group
POST/app-groups - Get app group by ID
GET/app-groups/{id} - Update app group
PATCH/app-groups/{id} - Delete app group
DELETE/app-groups/{id}
DeviceGroups¶
- List device groups
GET/device-groups - Create device group
POST/device-groups - Device group by ID
GET/device-groups/{id} - Update device group
PUT/device-groups/{id} - Delete device group
DELETE/device-groups/{id}
Devices¶
- Get list of devices
GET/devices - Create mobile device
POST/devices - Get by ID
GET/devices/{id} - Update mobile device
PUT/devices/{id} - Delete mobile device
DELETE/devices/{id} - List violations
GET/devices/{id}/compliance-violations - List installed apps
GET/devices/{id}/installed-apps - Get location
GET/devices/{id}/location - List assigned policies
GET/devices/{id}/policies - List device properties
GET/devices/{id}/properties - Create device property
POST/devices/{id}/properties - Update property by key
PUT/devices/{id}/properties/{propertyKey} - Delete property by key
DELETE/devices/{id}/properties/{propertyKey} - List IXM scan results
GET/devices/{id}/scan-results
Operating Systems¶
- List mobile OSs
GET/operating-systems - Get mobile OS by ID
GET/operating-systems/{id}
Policies¶
- List policies
GET/policies - Create policy
POST/policies - Get policy by ID
GET/policies/{id}
Settings¶
- Get IXM auto-enrollment
GET/settings/ixm-auto-enrollment - Set up IXM auto-enrollm
POST/settings/ixm-auto-enrollment - Update IXM auto-enrollm
PUT/settings/ixm-auto-enrollment - Delete IXM auto-enrollm
DELETE/settings/ixm-auto-enrollment
Static Setup Data¶
- IXM enrollment settings
GET/static-setup-data/ixm-auto-enrollment
Download¶