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 Group Commands API

APIs to run group commands. Command will be run on all the active devices in a group

Esper Group 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 Group 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 4 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 4 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 Group 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.

Group Commands 2

APIs to run group commands. Command will be run on all the active devices in a group

POST
/enterprise/{enterprise_id}/devicegroup/{group_id}/command/deprecated
Run commands on group devices
runGroupCommand 3 params → 201
GET
/enterprise/{enterprise_id}/devicegroup/{group_id}/command/{command_id}/deprecated
Get group command status
getGroupCommand 3 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are GroupCommand (12 properties), GroupCommandRequest (2 properties), GroupCommandArgs (1 property). Each schema is shown below with its type and property counts.

GroupCommandArgs
object
1 property
GroupCommand
object
12 properties 3 required
GroupCommandEnum
string
Group Command Options REBOOT: Reboot device LOCK: Lock device screen INSTALL: Install an app on device UPDATEHEARTBEAT: Ping Device
GroupCommandRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Esper publishes across the network.

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