About this task

Integrate SOTI MobiControl into your enterprise mobility workflow or partner applications using our RESTful web service API. SOTI MobiControl provides an interactive environment where you can experiment with the REST API.

To get to your interactive REST API environment:

Procedure

1. Log into your SOTI MobiControl console.
2. In the address bar of the web browser, replace everything after MobiControl/ with api and go to the new web page.

   For example, change https://soti.sotidemo.com/MobiControl/WebConsole/home/devices to https://soti.sotidemo.com/MobiControl/api.

Result

You have entered the interactive environment of the SOTI MobiControl REST API service. Detailed documentation on the available APIs is available directly within the API reference.

The syntax for filtering expressions differs between GET /devices/search and GET /devices endpoints.

Use advanced search expressions for GET /devices/search. For example, use filter=BatteryStatus%3E38%20AND%20CellularCarrier%3D%27Communications%20Network%27 to find devices with battery statuses greater than 35% AND whose cellular carrier has a name containing the terms "Communications Network".

Use name value pairs for GET /devices. For example, use {Family}:{Linux}, {IsAgentOnline}:{TRUE} to find Linux devices whose agents are online.

Before you begin

• Manage API clients permission. See General Permissions.

• The Allow Access to API Documentation option enabled. See Managing API Clients.

About this task

The documentation portal presents APIs in a structured interface that makes it easier to discover endpoints, review request parameters, and understand response formats. APIs are organized into categorized sections such as authentication, agents, client operations, and configuration APIs, allowing developers to quickly locate the endpoints relevant to their integration tasks.

Each endpoint includes an introduction describing what the API returns, along with a request section where you can specify required parameters. After the parameters are entered, the portal automatically generates the REST request syntax that can be copied or executed directly from the interface.

The documentation interface includes:

1. Search and advanced search capabilities to quickly locate APIs.
2. A categorized navigation panel that organizes APIs into logical sections.
3. Detailed endpoint information including request parameters and response schemas.

Procedure

1. Log in to your SOTI MobiControl web console.
2. In the browser address bar, replace everything after MobiControl/ with api.

   For example, change https://soti.sotidemo.com/MobiControl/WebConsole/home/devices to https://soti.sotidemo.com/MobiControl/api

   Result: The SOTI MobiControl API documentation portal opens.
3. Use the navigation panel on the left to browse API categories or use the search bar to locate a specific API endpoint.
4. Select an API endpoint to view its introduction, request parameters, schema, and response details.
5. Select the OAuth (oauth2) lock icon to authenticate before executing API requests if required.

   

   Result: This opens an authentication page. Enter your Client ID and Client Secret to get the authentication token required by selecting Get Token.

   

6. In the Request section, enter the required path parameters. Mandatory parameters are marked with an asterisk (*).

   Result: The documentation portal automatically generates the REST API request syntax based on the parameters entered. The generated request displays the HTTP method, endpoint URL, and required headers.

   

7. Test the request directly from the documentation portal by selecting Try.

   

   Result: If the request is executed, the response is displayed in the portal. Review the results of the request. The portal displays the API response in the following sections:

   • Response: Shows the returned payload from the API.
   • Response Headers: Displays HTTP headers returned by the server.

   

8. Scroll down to the Response section to find the response codes for the API command along with its example and schema.

   • 200: Success.
   • 400: Contract validation failed.
   • 401: Unauthorized access.
   • 403: Forbidden.

   

Result