Skip to content

ESPER API REFERENCE (1.0.0)

Introduction

Welcome to Esper’s API documentation. The Esper API allows users to accomplish operations outside of the console. Some common uses for our APIs include observing device information and console activity, installing and updating apps, uploading files, and sending files to devices. Our users have also used the API to automate app updates, perform bulk actions, and more.

Esper API endpoints use REST-based architecture and return JSON responses.

See our documentation for:

Authentication

You need to create an API Key to interact with our APIs. Learn more about generating an API Key. You can also learn more about Esper and sign up for an account at esper.io/signup.

Some endpoints also require an Enterprise ID. This ID can be found in the API Management section of the Esper console.

Pagination

Responses may be paginated. Use the following parameters to query the data. A full list of parameters can be found on the endpoint’s documentation page.

ParameterData TypeExplanation
limitintegerLimit the data returned. Default = 20.
offsetintegerOffset to the first item returned. Default = 0.
orderingstringOrder the results set by the field name. Varies by endpoint.
nextstringPaginate to the next response set.
previousstringPaginate to the last set response.

Errors

We use standard HTTP status codes for success or failure. A typical error response may look something like this:

{
  "errors": [],
  "message": "error message",
  "status": 400
}
  • errors - List of error details
  • message - Error description
  • status - HTTP status code

Some common status codes and messages are:

NumberMessageExplanation
200OKThe request succeeded.
201Resource creationA resource was created.
401UnauthorizedThe API key is invalid.
404Not foundThe resource was not found.
429Rate limit exceededToo many requests. Wait a moment and try again.
500Server errorInternal error. Wait a moment and try again. If the issue persists, contact Esper.

See how our systems are doing by checking our status page.

Rate Limits

To ensure quality of service for all customers, we enforce rate limits for API requests. Most customers won’t hit this limit with normal use. In case you experience 429 or rate limit exceeded errors, we recommend the following:

  • Try sending requests in batches.
  • Begin with about 20 requests at a time and building up from there.
  • Ensure your scripts are efficient and don’t contain redundant calls.
  • Reach out to your account manager to discuss your options.
Download OpenAPI description
openapi.json
openapi.yaml
Overview
E-mail
developer@esper.io
License
Apache 2.0
Terms of Service
Languages
Servers
Mock server
https://develop-api.esper.io/_mock/openapi
https://{foo}-api.esper.cloud/api

Company Settings

The Company Settings API manage the account information set up for your organization. Formerly known as Enterprise Information.

Operations

Application

APIs for application management

Operations

Application V1

APIs for application management

Operations

AndroidDevice

APIs for android device management

Operations

Device Group

APIs for device group management

Operations

Token (Deprecated)

⚠️ Deprecation Notice: The following APIs will soon be deprecated. Use the console to manage API keys instead.

Operations

Commands V2

Commands V2.0 provides advanced device commands capabilities like queuing, support for offline devices, dynamic device set for commands and command history. Commands 2.0 is in active development and we will add support for all the commands soon

Operations

List command requests

Request

API to get and filter command requests

Security
apiKey
Path
enterprise_idstring(uuid)required

ID of the enterprise

Query
command_typestring

Filter by type of command request i.e device, group etc

devicesstring

Filter by device IDs. Accepts comma separated values.

device_typestring

Filter by device type i.e active, inactive etc

commandstring

Filter by command name

issued_bystring

Filter by user. Accepts user id.

curl -i -X GET \
  'https://develop-api.esper.io/_mock/openapi/v0/enterprise/{enterprise_id}/command/?command_type=string&devices=string&device_type=string&command=string&issued_by=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

on successful request

Bodyapplication/json
countinteger(int64)
nextstring(url)
previousstring(url)
resultsArray of objects(V0CommandRequest)
Response
application/json
{
  "count": 0,
  "next": "string",
  "previous": "string",
  "results": [
    { … }
  ]
}

Create a command request

Request

API to create a command request for the device.

Security
apiKey
Path
enterprise_idstring(uuid)required

ID of the enterprise

Body*/*required

The request body to create a command for set of devices or groups

command_typestring

Identifies the type of command

* DEVICE: command request is meant for devices
* GROUP: command request is meant for groups
* DYNAMIC: command request is meant for dynamic set of devices
  i.e subset of devices from different groups or otherwise.
Enum"DEVICE""GROUP""DYNAMIC"
devicesArray of strings(uuid)[ 0 .. 1000 ] items

list of devices to run commands

groupsArray of strings(uuid)[ 0 .. 500 ] items

list of groups to run commands

commandstring(V0DeviceCommandEnum)

Following commands are supported

* ADD_TO_WHITELIST: Whitelist an installed sytem app. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper
* ADD_WIFI_AP : Add wifi access points for device. Requires `wifi_access_points` in command arguments where `wifi_access_points` is the data with access points
* CLEAR_APP_DATA : Clear data for an installed app. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper
* INSTALL: Install an app on a device. Requires `app_version` in command arguments where `app_version` is the version id of app uploaded on Esper
* LOCK: Lock device screen
* REBOOT: Reboot a device
* REMOVE_FROM_WHITELIST : Remove an installed system app from whitelist. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper
* REMOVE_WIFI_AP : Remove Wifi access points for device. Requires `wifi_access_points` in command arguments where `wifi_access_points` is the data with access points
* SET_APP_PERMISSION : Set permission for an installed app. Requires `package_name`, `grant_state`, `permission` in command arguments where `package_name` is the app package uploaded on Esper, `grant_state` should be "PERMISSION_GRANT_STATE_DEFAULT", "PERMISSION_GRANT_STATE_DENIED", "PERMISSION_GRANT_STATE_GRANTED" and `permission` is a valid permission
* SET_APP_STATE : Set the state of an app - SHOW/HIDE/DISABLE/LAUNCHABLE_BUT_HIDDEN. Requries `app_state` and `package_name` in command arguments where `app_state` is the state of app and `package_name` is the app package uploaded on Esper
* SET_BLUETOOTH_STATE : Set bluetooth state (ON/OFF) for device. Requires `bluetooth_state` in command arguments where `bluetooth_state` is a boolean.
* SET_BRIGHTNESS_SCALE : Set brightness for device. Requires `brightness_value` in command arguments where `brightness_value` is an integer (1-100).
* SET_DEVICE_LOCKDOWN_STATE : Set lockdown state for a device. Requires `state` and `message` in command arguments where `state` is LOCKED/UNLOCKED and `message` is the message to be added with command
* SET_GPS_STATE :Set the GPS state for a device. Requires `gps_state` in command arguments where `gps_state` should be either 0, 1, 2, 3 or 4 (LOCATION_MODE_HIGH_ACCURACY = 0, LOCATION_MODE_SENSORS_ONLY = 1, LOCATION_MODE_BATTERY_SAVING = 2, LOCATION_MODE_OFF = 3, LOCATION_MODE_ON = 4)
* SET_KIOSK_APP : Command to set the Kiosk app for a device. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper
* SET_NEW_POLICY : Apply policy on device. Requires `policy_url` in command arguments where `policy_url` is the URL to the policy
* SET_ROTATION_STATE : Set screen orientation. Requires `rotate_state` in command arguments where `rotate_state` should be either 0, 1 or 2 (0 = AUTO, 1 = PORTRAIT_ONLY, 2 = LANDSCAPE_ONLY)
* SET_SCREEN_OFF_TIMEOUT: Set screen off timeout for a device. Requires `screen_off_timeout` in command arguments where `screen_off_timeout` should be either -1 or between 5000 and 1800000
* SET_STREAM_VOLUME : Set stream volume for a device. Requires `stream` and `volume_level` in command arguments where `stream` should be either 0(Ring), 1(Notification), 2(Alarm) or 3(Music) and `volume_level` should be a value from 0 to 100
* SET_TIMEZONE : Set the timezone for a device. Requires `timezone_string` in command arguments where `timezone_string` is a valid string representing the timezone
* SET_WIFI_STATE : Set the wifi state (ON/OFF) for a device. Requires `wifi_state` in command arguments where `wifi_state` is a boolean.
* UNINSTALL: Uninstall an app from device. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper
* UPDATE_DEVICE_CONFIG: Push additional configurations to the Device
* UPDATE_HEARTBEAT: Ping a device
* UPDATE_LATEST_DPC : Prompt device to update the DPC app to the latest versions.
* WIPE : Wipes the device.
* RESET_LOCKSCREEN_PASSWORD: Change the lockscreen password of the device. Requires `new_lockscreen_password` in command arguments where `new_lockscreen_password` is a valid string.
* CAPTURE_SCREENSHOT: Allows you to take a screenshot of the device's current screen. The "tag" is an optional param that can be set to corresponding screenshot.
* UPDATE_BLUEPRINT: Pushes or reapplies the most current Blueprint version to the device or group.
* NOTIFY_DEVICE: Allows you to  broadcast message to the device. Requires 'title', 'message' and 'url' (optional) as string in command arguments. For scheduled message command requires 'name', 'time_type' as string and 'start_datetime' and 'end_datetime' as date-time.
* SET_DEVICE_LANGUAGE: Set language for a device. Requires locale value in xx[_Zzzz]_yy where xx is language code, Zzzz is script (optional) and yy is country code.
* SET_ETHERNET_SETTINGS: Set ethernet settings on supported Device
* SET_STATIC_IP: Set static ip on the deivce. Requires interface, dhcp_dnabled, static_ip, primary_dns, subnet_mask, gateway, secondary_dns (optional)
* BEEP_DEVICE: Allows you to make the device beep for a specified duration
* SET_APP_NOTIFICATIONS: Enable/disable app notifications. Requries `app_notifications_state` and `package_name` in command arguments where `app_notifications_state` is a string that has the value `ENABLED` or `DISABLED` and `package_name` is the app package uploaded on Esper.
* USE_ONLY_SAVED_WIFI_AP: Allow/disallow device to connect to unregistered WiFi APs. Requires boolean `use_only_saved_ap`.
* CONVERGE: Allows you to converge the device to the latest version of its assigned blueprint.
* SYNC_CONTENT: Allows you to sync content to the device. Requires `content_id` in command arguments where `content_id` is the id of the content to be synced. ```
Enum"ADD_TO_WHITELIST""ADD_WIFI_AP""CLEAR_APP_DATA""INSTALL""LOCK""REBOOT""REMOVE_FROM_WHITELIST""REMOVE_WIFI_AP""SET_APP_PERMISSION""SET_APP_STATE"
command_argsobject(Command args)
schedulestring(V0CommandScheduleEnum)

Following Schedule types are supported

* IMMEDIATE: Schedule the command to execcute Immediately
* WINDOW: Schedule the command to execute within the given window
* RECURRING: Schedule the command to execute during the scheduled time until it succeeds or expires. After executing successfully, it will not fire again.
Enum"IMMEDIATE""WINDOW""RECURRING"
schedule_argsobject(Command Schedule Arguments)
curl -i -X POST \
  'https://develop-api.esper.io/_mock/openapi/v0/enterprise/{enterprise_id}/command/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

command request successfully created

Bodyapplication/json
idstring(uuid)(Id)read-only

Unique command request identifier

enterprisestring(uuid)(Enterperise ID)read-only

Esper account identifier

command_typestring

Identifies the type of command

* DEVICE: command request is meant for devices
* GROUP: command request is meant for groups
* DYNAMIC: command request is meant for dynamic set of devices
  i.e subset of devices from different groups or otherwise.
Enum"DEVICE""GROUP""DYNAMIC"
devicesArray of strings(uuid)[ 0 .. 1000 ] items

list of devices to run commands

groupsArray of strings(uuid)[ 0 .. 500 ] items

list of groups to run commands

commandstring(V0DeviceCommandEnum)

Following commands are supported

* ADD_TO_WHITELIST: Whitelist an installed sytem app. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper
* ADD_WIFI_AP : Add wifi access points for device. Requires `wifi_access_points` in command arguments where `wifi_access_points` is the data with access points
* CLEAR_APP_DATA : Clear data for an installed app. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper
* INSTALL: Install an app on a device. Requires `app_version` in command arguments where `app_version` is the version id of app uploaded on Esper
* LOCK: Lock device screen
* REBOOT: Reboot a device
* REMOVE_FROM_WHITELIST : Remove an installed system app from whitelist. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper
* REMOVE_WIFI_AP : Remove Wifi access points for device. Requires `wifi_access_points` in command arguments where `wifi_access_points` is the data with access points
* SET_APP_PERMISSION : Set permission for an installed app. Requires `package_name`, `grant_state`, `permission` in command arguments where `package_name` is the app package uploaded on Esper, `grant_state` should be "PERMISSION_GRANT_STATE_DEFAULT", "PERMISSION_GRANT_STATE_DENIED", "PERMISSION_GRANT_STATE_GRANTED" and `permission` is a valid permission
* SET_APP_STATE : Set the state of an app - SHOW/HIDE/DISABLE/LAUNCHABLE_BUT_HIDDEN. Requries `app_state` and `package_name` in command arguments where `app_state` is the state of app and `package_name` is the app package uploaded on Esper
* SET_BLUETOOTH_STATE : Set bluetooth state (ON/OFF) for device. Requires `bluetooth_state` in command arguments where `bluetooth_state` is a boolean.
* SET_BRIGHTNESS_SCALE : Set brightness for device. Requires `brightness_value` in command arguments where `brightness_value` is an integer (1-100).
* SET_DEVICE_LOCKDOWN_STATE : Set lockdown state for a device. Requires `state` and `message` in command arguments where `state` is LOCKED/UNLOCKED and `message` is the message to be added with command
* SET_GPS_STATE :Set the GPS state for a device. Requires `gps_state` in command arguments where `gps_state` should be either 0, 1, 2, 3 or 4 (LOCATION_MODE_HIGH_ACCURACY = 0, LOCATION_MODE_SENSORS_ONLY = 1, LOCATION_MODE_BATTERY_SAVING = 2, LOCATION_MODE_OFF = 3, LOCATION_MODE_ON = 4)
* SET_KIOSK_APP : Command to set the Kiosk app for a device. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper
* SET_NEW_POLICY : Apply policy on device. Requires `policy_url` in command arguments where `policy_url` is the URL to the policy
* SET_ROTATION_STATE : Set screen orientation. Requires `rotate_state` in command arguments where `rotate_state` should be either 0, 1 or 2 (0 = AUTO, 1 = PORTRAIT_ONLY, 2 = LANDSCAPE_ONLY)
* SET_SCREEN_OFF_TIMEOUT: Set screen off timeout for a device. Requires `screen_off_timeout` in command arguments where `screen_off_timeout` should be either -1 or between 5000 and 1800000
* SET_STREAM_VOLUME : Set stream volume for a device. Requires `stream` and `volume_level` in command arguments where `stream` should be either 0(Ring), 1(Notification), 2(Alarm) or 3(Music) and `volume_level` should be a value from 0 to 100
* SET_TIMEZONE : Set the timezone for a device. Requires `timezone_string` in command arguments where `timezone_string` is a valid string representing the timezone
* SET_WIFI_STATE : Set the wifi state (ON/OFF) for a device. Requires `wifi_state` in command arguments where `wifi_state` is a boolean.
* UNINSTALL: Uninstall an app from device. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper
* UPDATE_DEVICE_CONFIG: Push additional configurations to the Device
* UPDATE_HEARTBEAT: Ping a device
* UPDATE_LATEST_DPC : Prompt device to update the DPC app to the latest versions.
* WIPE : Wipes the device.
* RESET_LOCKSCREEN_PASSWORD: Change the lockscreen password of the device. Requires `new_lockscreen_password` in command arguments where `new_lockscreen_password` is a valid string.
* CAPTURE_SCREENSHOT: Allows you to take a screenshot of the device's current screen. The "tag" is an optional param that can be set to corresponding screenshot.
* UPDATE_BLUEPRINT: Pushes or reapplies the most current Blueprint version to the device or group.
* NOTIFY_DEVICE: Allows you to  broadcast message to the device. Requires 'title', 'message' and 'url' (optional) as string in command arguments. For scheduled message command requires 'name', 'time_type' as string and 'start_datetime' and 'end_datetime' as date-time.
* SET_DEVICE_LANGUAGE: Set language for a device. Requires locale value in xx[_Zzzz]_yy where xx is language code, Zzzz is script (optional) and yy is country code.
* SET_ETHERNET_SETTINGS: Set ethernet settings on supported Device
* SET_STATIC_IP: Set static ip on the deivce. Requires interface, dhcp_dnabled, static_ip, primary_dns, subnet_mask, gateway, secondary_dns (optional)
* BEEP_DEVICE: Allows you to make the device beep for a specified duration
* SET_APP_NOTIFICATIONS: Enable/disable app notifications. Requries `app_notifications_state` and `package_name` in command arguments where `app_notifications_state` is a string that has the value `ENABLED` or `DISABLED` and `package_name` is the app package uploaded on Esper.
* USE_ONLY_SAVED_WIFI_AP: Allow/disallow device to connect to unregistered WiFi APs. Requires boolean `use_only_saved_ap`.
* CONVERGE: Allows you to converge the device to the latest version of its assigned blueprint.
* SYNC_CONTENT: Allows you to sync content to the device. Requires `content_id` in command arguments where `content_id` is the id of the content to be synced. ```
Enum"ADD_TO_WHITELIST""ADD_WIFI_AP""CLEAR_APP_DATA""INSTALL""LOCK""REBOOT""REMOVE_FROM_WHITELIST""REMOVE_WIFI_AP""SET_APP_PERMISSION""SET_APP_STATE"
command_argsobject(Command args)
schedulestring(V0CommandScheduleEnum)

Following Schedule types are supported

* IMMEDIATE: Schedule the command to execcute Immediately
* WINDOW: Schedule the command to execute within the given window
* RECURRING: Schedule the command to execute during the scheduled time until it succeeds or expires. After executing successfully, it will not fire again.
Enum"IMMEDIATE""WINDOW""RECURRING"
schedule_argsobject(Command Schedule Arguments)
issued_bystring(url)read-only

command is issued by this user

created_onstring(date-time)(Created on)read-only

Timestamp of command request

statusArray of objects(Current Status)read-only

Show current status of commands issued during this request

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  "command_type": "DEVICE",
  "devices": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "groups": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "command": "ADD_TO_WHITELIST",
  "command_args": {
    "device_alias_name": "string",
    "custom_settings_config": {},
    "app_version": "string",
    "package_name": "string",
    "policy_url": "string",
    "wifi_access_points": {},
    "state": "string",
    "message": "string",
    "title": "string",
    "url": "string",
    "app_state": "string",
    "bluetooth_state": true,
    "brightness_value": 0,
    "gps_state": 0,
    "rotate_state": 0,
    "screen_off_timeout": 0,
    "stream": 0,
    "volume_level": 0,
    "timezone_string": 0,
    "wifi_state": true,
    "wifi_revert_timeout": 0,
    "locale": "string",
    "ethernet_auth_mode": "NONE",
    "ethernet_ca_cert_alias": "string",
    "ethernet_client_cert_alias": "string",
    "ethernet_eap_identity": "string",
    "interface": "string",
    "dhcp_enabled": "string",
    "static_ip": "string",
    "primary_dns": "string",
    "subnet_mask": "string",
    "secondary_dns": "string",
    "gateway": "string",
    "duration": "string",
    "tag": "string",
    "video_quality": "string",
    "enable_debug_mode": false,
    "converge_with_provision_option": false,
    "auto_update_mode": "autoUpdateDefault",
    "content_id": "string"
  },
  "schedule": "IMMEDIATE",
  "schedule_args": {
    "name": "string",
    "start_datetime": "2019-08-24T14:15:22Z",
    "end_datetime": "2019-08-24T14:15:22Z",
    "time_type": "console",
    "window_start_time": "string",
    "window_end_time": "string",
    "days": [ … ]
  },
  "issued_by": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "status": [
    { … }
  ]
}

get status list for command request

Request

API to get and filter command request status

Security
apiKey
Path
enterprise_idstring(uuid)required

ID of the enterprise

request_idstring(uuid)required

ID for the command request

Query
devicestring

Filter status result by device id.

statestring

Filter by command state

curl -i -X GET \
  'https://develop-api.esper.io/_mock/openapi/v0/enterprise/{enterprise_id}/command/{request_id}/status/?device=string&state=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

on successful request

Bodyapplication/json
countinteger(int64)
nextstring(url)
previousstring(url)
resultsArray of objects(V0CommandStatus1)
Response
application/json
{
  "count": 0,
  "next": "string",
  "previous": "string",
  "results": [
    { … }
  ]
}

Enterprise Policy

APIs to Esper Compliance Policy

Operations

Geofence

APIs for geofence management

Operations

Content

APIs to manage files

Operations

User (Deprecated)

⚠️ Deprecation Notice: The following APIs will soon be deprecated. Please transition to the User APIs.

Operations

User

APIs for User Management

Operations

Blueprint (Deprecated)

This is the API for the former Blueprints service.

⚠️ Deprecation Notice: The following APIs will soon be deprecated. Use Blueprints API instead.

Operations

Directory Record

APIs for Directory Record management. These APIs are only available to the customers using the new Onboarding experience.

Operations

Tile Icon

APIs to manage tile icons. Tile icons allow Templates-based users to apply a icons to devices.

Operations

Alerts

Operations

Alarms

Operations

Wallpapers

Operations

Device Telemetry

Operations

Daily and Custom Reports

Operations

SSO Connections

Operations

Roles

Operations

Personal Access Token

Operations

Blueprints API

APIs to manage blueprints. Learn more about blueprints.

Operations

Custom Actions API

APIs to manage custom actions. Custom actions allow you to define custom scripts and commands that can be executed on Linux devices. Currently, only Linux platform is supported for custom actions.

Operations

System Status Code

System status code descriptions

  • 900 (INTERNAL_REQUEST_SKIPPED) - Response code is used when a request is valid, but cannot be fulfilled.

System

System level APIs

Operations

Pipelines

Pipelines composition APIs

Operations

Stages

APIs to modify Stage information

Operations

Target Lists

APIs to modify Target List

Operations

Targets

Targets subsystem

Operations

Device Groups

APIs to modify Device Groups

Operations

Operation Lists

APIs to modify Operation List

Operations

Operations

Operations subsystem

Operations

Pipeline Runs

APIs to manage Pipeline Runs. Pipeline run status descriptions

  • PENDING - Pipeline run created.
  • QUEUED - Pipeline run queued for processing.
  • PROCESSING - Pipeline run received by scheduler for processing. (Processing a pipeline involves performing the operations required before starting a pipeline)
  • RUNNING - Pipeline run has started running.
  • WAITING - Pipeline run is waiting for an action (manual/automatic).
  • COMPLETE - The pipeline run has completed processing i.e. All stage runs are processed. A complete pipeline run can move to success or failure.
  • SUCCESS - A completed pipeline run moves to success if all stage runs are successful.
  • FAILURE - A completed pipeline run moves to failure if all stage runs are not successful.
  • CANCELLED - Pipeline run is cancelled by the user.
  • TIMEOUT - The pipeline run has a timed out. This happens when the pipeline has not completed processing even after the timeout period (Default 21 days).
  • INVALID - A pipeline run moves to invalid state when Pipeline run has no stageruns i.e pipeline has zero stages.
Operations

Stage Runs

APIs to manage Stage Runs. Stage run status descriptions

  • PENDING - Stage run created.
  • QUEUED - Stage run queued for processing.
  • PROCESSING - Stage run received by scheduler for processing.(Processing a stage run can involve performing the operations required before starting a stage run. In this case creating the target runs for the stage.)
  • RUNNING - Stage run has started running.
  • COMPLETE - Stage run moves to complete if all target runs are complete (target runs are complete if they are in a terminal state).
  • SUCCESS - A completed stage run moves to success if all target runs are successful.
  • FAILURE - A completed stage moves to failure if all target runs are not successful.
  • CANCELLED - Stage run cancelled by user.
  • TIMEOUT - The stage run has a timed out. This happens when the stage run has not completed processing even after the timeout period (Default 7 days).
  • INVALID - A stage run moves to invalid state when a. The associated stage has no targets. b. The associated stage has no operations.
Operations

Target Runs

APIs to manage Target Runs. Target run status descriptions

  • PENDING - Target run created.
  • QUEUED - Target run queued for processing.
  • PROCESSING - Target run received by scheduler for processing (During target run processing the command request for the target run is created).
  • DISPATCHED - Target run moves to dispatched when a command is successfully queued for the target run. (Command status - QUEUED)
  • RUNNING - Target run moves to running state when the command has been sent to the device (Command status - INITIATED, ACKNOWLEDGED, INPROGRESS)
  • COMPLETE - Target run moves to complete state when it has completed running (Command status - FAILURE, SUCCESS, TIMEOUT, CANCELLED)
  • SUCCESS - A completed target run moves to success when the associated command is successful (Command status - SUCCESS)
  • FAILURE - A completed target run moves to success when the associated command is unsuccessful (Command status - FAILED, TIMEOUT, CANCELLED)
  • CANCELLED - Target run cancelled by the user (Target runs ind Pending, Queued and Processing state can be cancelled by the user)
  • TIMEOUT - The target run has a timed out. This happens when the target run has not completed processing even after the timeout period (7 days).
  • INVALID - Target run is invalid.
Operations

Device

APIs to retrieve information about the device or delete the device.

Operations

Device Heartbeat

APIs to retrieve information about device's heartbeat which contains the last seen details.

Operations

Device Apps

APIs to get apps installed on iOS devices. Use Application to get apps for Android devices.

Operations

Device Enrollment in EMM

APIs to enroll device with Google EMM

Operations

Operations [alpha]

APIs to get information about operations

Operations

DeviceOperations [alpha]

APIs to get information about device operations

Operations

MultiOS Remote Viewer

API to get Remote Viewer activity for the tenant. Currently supports only Android devices with DPC 8.4 and above along with RemoteViewer 3.x.

Operations

Device V2

Operations

VPP License Management

APIs for managing VPP licenses for apps. Learn more about VPP licenses.

Operations

VPP App Management

APIs for getting information about VPP apps. Learn more about VPP apps.

Operations

Tenant Apps

API to manage Enterprise iOS apps for a tenant.

Operations

Apple App Store

API to search apple app store for apps

Operations

App List

Unified API to query Webclips and Tenant IOS Apps

Operations

Webclips

API to manage webclips for a tenant

Operations

Provisioning Profiles

APIs for managing iOS provisioning profiles for app distribution

Operations

Esper Apps

Operations

Tenant Esper Apps

Operations

Command Request

APIs to view and manage command requests. Learn more about commands or how to schedule a command.

Scheduled commands are currently compatible with Android devices.

Operations

Command Status

APIs to view, filter, and manage command requests.

Operations

Converge

APIs to list and create converge actions for devices. Learn more about converge.

Operations

Converge Command

API for converge command

Operations

DEP Sync Request

APIs to create and access DEP sync request information. Use DEP sync to sync the information from your Apple Business Manager account to the Esper console.

Operations

ABM Provisioning

APIs to perform ABM provisioning. Learn more about ABM provisioning

Operations

APNs certificate

APIs for managing APNS certificates. Learn more about APNS certificates

Operations

DEP Tokens

APIs to create and access DEP tokens. Learn more about DEP tokens

Operations

VPP Token Management

APIs to create, access, and delete VPP tokens. Learn more about VPP tokens.

Operations

Google Enterprise

APIs to enroll the enterprise in Google EMM.

Operations

FoundryBuilds

Operations

FoundryDeviceModels

Operations

FoundryEvents

Operations

Reports API

APIs for managing reports.
Currently supports App Reports.

Operations

Query API

Operations

Ingest API

Operations