Introduction

This API offers the following features:

• Find Device by IMEI
• Get last known location for a device
• Securely wipe a device
• Suspend/Unsuspend device
• Get whether a device has exceeded any data usage alerts

Overview

Things that the developers should know about

Base URL

All API calls should begin with the URL: https://api.ensemblemdm.com/v1

So, an example of calling our API should look like this:

• GET https://api.ensemblemdm.com/v1/usage

Authentication

Interacting with the API requires sending an 'x-api-key' header with each request. To retrieve an API Key, please reach out to us at engineering@conversasolutions.com

header['x-api-key'] = API_KEY

NOTE API Keys are unavailable at the moment.

Status Codes

We use conventional HTTP response codes to indicate the success or failure of an API request.

• 2xx range: success
• 4xx range: error that failed given the information provided
• 5xx range: error with our servers (these are rare).

200 - OK

Everything worked as expected.

400 - Bad Request

The request was unacceptable, often due to missing a required parameter or if data you provided fails validation. Check our documentation to confirm that the data type you are sending matches what our server expects.

500, 502, 503, 504 - Server Errors

There was an error on our end. This should be rare, so please reach out to us if you continue to receive these status codes.

Rate limit

Yes. No more than 1000 requests every 100 seconds