Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Esper Commands API

APIs to run device commands.`This version of commands is being deprecated and documentation will be archived soon. Please use Commands V2.`

Esper Commands API is one of 13 APIs that Esper publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Commands. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

Requests are made against the base URL https://foo-api.esper.cloud/api.

2 operations 2 paths 7 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://foo-api.esper.cloud/api
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Esper Commands API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey).

  • apiKey — API KEY - Access Token Access token for APIs passed as authorization header in calls. You need to generate this from your Esper Dev Console at -api.esper.cloud…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Commands 2

APIs to run device commands. This version of commands is being deprecated and documentation will be archived soon. Please use Commands V2.

POST
/enterprise/{enterprise_id}/device/{device_id}/command/deprecated
Run commands on device
runCommand 3 params → 200
GET
/enterprise/{enterprise_id}/device/{device_id}/command/{command_id}/deprecated
Get command status
getCommand 3 params → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are DeviceCommand (15 properties), CommandArgs (12 properties), CommandRequest (2 properties). Each schema is shown below with its type and property counts.

SettingsGPSStateEnum
integer
Device settings GPS state enum LOCATIONMODEHIGHACCURACY = 0 LOCATIONMODESENSORSONLY = 1 LOCATIONMODEBATTERYSAVING = 2 LOCATIONMODEOFF = 3
DeviceCommand
object
15 properties 3 required
SettingsRotateStateEnum
integer
Device settings rotate state enum AUTO = 0 PORTRAITONLY = 1 LANDSCAPEONLY = 2
CommandArgs
object
12 properties
CommandRequest
object
2 properties 1 required
SettingsVolumeStreamEnum
integer
Device settings volume stream enum STREAMRING = 0 STREAMNOTIFICATION = 1 STREAMALARM = 2 STREAMMUSIC = 3
DeviceCommandEnum
string
Command Options REBOOT: Reboot device LOCK: Lock device screen INSTALL: Install an app on device UNINSTALL: Uninstall an app from device WIPE: Wipe device UPDA…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

esper-commands-api-openapi.yml Raw ↑

Other APIs Esper publishes across the network.

Esper Application API
Esper Application V1 API
Esper Commands V2 API
Esper Content API
Esper Device API
Esper Device Group API
Esper Enterprise API
Esper Enterprise Policy API
Esper Geofence API
Esper Group Commands API
Esper Subscription API
Esper Token API