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 V2 API

Commands V2.0 is to provide 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 support for all the commands will be added soon.

Esper Commands V2 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 V2. 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 4 operations across 3 paths, and defines 8 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.

4 operations 3 paths 8 schemas 3 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 V2 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 4

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

Commands V2 4

Commands V2.0 is to provide advanced device commands capabilities like queuing, support for offline devices, dynamic device set for commands and command history. Commands 2.0 is i…

POST
/v0/enterprise/{enterprise_id}/command/
Create a command request
createCommand 2 params → 201
GET
/v0/enterprise/{enterprise_id}/command/
List command requests
listCommandRequest 6 params → 200
GET
/v0/enterprise/{enterprise_id}/command/{request_id}/status/
get status list for command request
getCommandRequestStatus 4 params → 200
GET
/v0/enterprise/{enterprise_id}/device/{device_id}/command-history/
get command history for device
getDeviceCommandHistory 3 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are V0CommandArgs (19 properties), V0CommandRequest (13 properties), V0CommandStatus (7 properties), V0CommandScheduleArgs (7 properties). Each schema is shown below with its type and property counts.

V0DeviceCommandEnum
string
Following commands are supported ADDTOWHITELIST: Whitelist an installed sytem app. Requires packagename in command arguments where packagename is the app packa…
V0CommandScheduleArgsTimeTypeEnum
string
The Time-Type argument, in Schedule args, is to indicate which timezone the Command Framework should utilize when scheduling the command. Following Schedule Ar…
V0CommandScheduleEnum
string
Following Schedule types are supported IMMEDIATE: Schedule the command to execcute Immediately WINDOW: Schedule the command to execute within the given window…
V0CommandRequest
object
13 properties
V0CommandArgs
object
19 properties
V0CommandRequestStatus
object
2 properties
V0CommandStatus
object
7 properties
V0CommandScheduleArgs
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

esper-commands-v2-api-openapi.yml Raw ↑

Other APIs Esper publishes across the network.

Esper Application API
Esper Application V1 API
Esper Commands 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