Search
Introduction
Authentication
Pagination
Errors
Rate Limits
ESPER CLOUD API
Enterprise
get
Get your enterprise information
patch
Partial update enterprise information
Application
get
List apps in enterprise
get
Get application information
del
Delete an application
get
List App versions
get
Get app version information
del
Delete app version
patch
Patch an App version instance
get
List install devices
post
Upload an application to enterprise
get
List Google enterprises
get
Get Google enterprise information
get
List webtokens
post
Creates a webtoken instance
get
Get webtoken instance
put
Updates webtoken instance
patch
Patches webtoken instance
del
Deletes a webtoken instance
get
List Google Play applications
post
Post a Google play application
get
Get application information
put
Update application instance
patch
Patch application instance
del
Delete application instance
get
List product installations
get
Gets minimum information regarding application
Application V1
get
List apps in enterprise
get
Get application information
del
Delete an application
get
List App versions
get
Get app version information
del
Delete app version
patch
Patch an App version instance
get
List install devices
AndroidDevice
get
Fetch all devices in an enterprise
get
Fetch device details by ID
get
List all device apps
get
Get device app details
get
List installed apps
get
Get latest device event
get
Download Event Feed for Device
get
Download Event Feed for Group
get
Lists event feed for device
get
Get last seen details of the device
Device Group
get
List device groups
post
Create a device group
get
Get device group information
put
Update device group
del
Delete a device group
patch
Partially update a device group
post
Upload a thumbnail pic
get
List thumbnail pics
get
Get thumbnail detail
del
Delete group thumbnail
get
List the subgroups of list of groups
Token
post
Renew Token
get
Token Information
Commands V2
get
List command requests
post
Create a command request
get
get status list for command request
get
get command history for device
Enterprise Policy
get
List all policies in enterprise
post
Create a new Enterprise Policy
get
Get Enterprise Policy
put
Update Enterprise Policy
del
Delete a Enterprise Policy
patch
Partial update EnterprisePolicy
Geofence
get
List Geofences in Enterprise
get
Get geofence information
put
Update geofence information
del
Delete a geofence
patch
Partially updates geofence information
post
Create a geofence
get
List Geofences in Enterprise
get
Get geofence information
del
Delete a geofence
Content
get
List content
get
Get content information
del
Delete Content
patch
Patch a content instance
post
Upload new content
User (Deprecated)
post
Create a new User
put
Update a User
patch
Partial update a User
del
Delete a user
User
get
User information
post
Invite a user
get
List user invites
del
Delete a invite
get
Get Users
get
Get User Information
put
Update user role
put
Update user profile
get
Get user groups
del
Delete a user from Enterprise
Blueprint (Deprecated)
get
Get list of Blueprints for the group
post
Create a Blueprint
get
Get Blueprint detail
patch
Partial update a Blueprint
del
Delete a Blueprint
get
Get list of Blueprint Revisions
get
Get Blueprint Revision detail
post
Restore a Blueprint
post
Upload a Blueprint
Directory Record
get
Get all Directory Records
post
Create a new Directory Record
get
Get details about a Directory Record
put
Update a Directory Record
del
Delete a Directory Record
Tile Icon
get
Get List of Device Tile Icons
post
Create a tile icon
get
Get instance of a tile icon
del
Delete a tile icon
post
Set a tile icon for a device
post
Removes tile icon for device
Alerts
get
List alert channels in enterprise
post
Creates alert channel
get
Get alert channel
put
Update alert channel information
patch
Partially updates alert channel information
del
Delete an alert channel
Alarms
get
Get list of alarm rules
post
Creates instance of alarm rules
get
Get instance of alarm rule
put
Update alarm rules
patch
Partially updates alarm rules
del
Deletes alarm rule
get
Get history of alarm rule
Wallpapers
get
Get list of wallpapers
post
Create wallpaper
get
Get instance of wallpaper
del
Deletes instance of wallpaper
UI
get
Gets list of user UI configurations
post
Create user UI configuration
get
Get instance of user UI configuration
put
Updates instance of user UI configuration
patch
Partially updates user UI configuration
del
Deletes instance of user UI configuration
Dashboard
get
Get alert triggers within start and end date
get
Gets data from provisioned device panel
Device Telemetry
get
Get list of device locations
get
Get location of specific device
get
Get list of device tiles reports
get
Get instance of device tiles report
get
Get status metrics report for enterprise
get
Get status metrics report for enterprise v2
Daily and Custom Reports
get
Get report information
get
Get device status reports within specified date-time range
get
Get enterprise report
get
Get group report
get
Get list of subscription reports
post
Post subscription to enterprise
get
Get instance of subscription
put
Update subscription
patch
Partially update subscription
del
Deletes instance of subscription
Connections
get
List connections
Roles
get
List Roles API
post
Create New Role API
get
Get Role API
patch
Patch Role API
del
Delete Role API
put
Update Role Scopes API
get
List Role Scopes API
Personal Access Token
post
Generate a new personal access token
get
Get tokens for corresponding user and tenant
put
Renew personal access token
del
Delete personal access token
BLUEPRINTS
Blueprints API
get
Retrieve all blueprints
post
Create a new blueprint
get
Retrieve a blueprint by ID
put
Update a blueprint by ID
del
Delete a blueprint by ID
get
Retrieve all versions of a blueprint
get
Retrieve a specific version of the blueprint
PIPELINES
System Status Code
System
get
Health check endpoint
Pipelines
get
Get all Pipelines for the Enterprise
post
Create a new Pipeline
get
Get a Pipeline
put
Update a Pipeline
del
Delete a Pipeline
Stages
get
Get all Pipeline stages
post
Create a Pipeline stage
get
Get a Pipeline Stage
put
Update a Pipeline Stage
del
Delete a pipeline stage
get
Get all Target Lists attached to the Stage
post
Attach the Target List to the Stage
del
Detach the Target List from the Stage
Target Lists
get
Get all Target Lists in Pipeline
post
Create a Target List
get
Get a Pipeline Target list
put
Update a Pipeline Target List
del
Delete a Pipeline Target list
Targets
get
Get all Targets in the Target List
post
Create a target for the target list
get
Get one target from target list
put
Update a target in the target list
del
Delete a Target or Device from a Target List
Device Groups
get
Get all Device Groups in the Target List
post
Add a Device Group to the Target List
del
Delete Device Group from a Target List
get
Get all Devices in the device group
Operation Lists
get
Get all Operation Lists attached to the Stage
post
Create an Operation list for the Stage
put
Update an Operation List
del
Delete stage operation list
Operations
get
Get all Operations in the Operation List
post
Create an Operation for Operation List
get
Get an Operation from the operation list
put
Update an Operation
del
Delete an Operation list operation
Pipeline Runs
get
Get all Runs for the Pipelines in the Enterprise
get
Get all Runs for the Pipeline
post
Create a Pipeline Run
get
Get Pipeline run by pipeline run id
put
Update a Pipeline Run
del
Delete a Pipeline Run
Stage Runs
get
Get all Stage Runs for the Pipeline Run
get
Get Pipeline Stage run by stage run Id
put
Update a Pipeline Stage Run
get
Get all Operations for the Stage Run
get
Get single Operation for the Stage Run
Target Runs
get
Get all Target Runs for the Stage Run
post
Create a Target Runs for Stage Run
get
Get Target Run by Target Run ID
put
Update a Target Run
get
Get status of the command running for Target run
post
Create an command processor request for Target Run
put
Update target run command information.
DEVICE
Device
get
Get all devices in the tenant
get
Get details of a Device
del
Delete a Device. Only supports Apple devices.
get
Get details of Current Device State
Device Heartbeat
get
Get last seen of a Device.
get
Get list of heartbeat details for devices
Device Apps
get
Get all apps for a device in the tenant
get
Get list of devices with an app by app_id or app_version_id.
Device Enrollment in EMM
get
Get the Google EMM Policy details for a specific device.
get
Return the Google account details of the EMM enrollment stored in the database for the specified device.
APPS MANAGEMENT
VPP License Management
get
Get VPP License List
get
Get VPP License Info about an App
VPP App Management
get
Get iOS App Info (v2)
Tenant Apps
post
Upload tenant app for a tenant
get
Get tenant apps for a tenant
get
Get tenant app by ID
get
Get tenant app versions by app ID
get
Get tenant app version by ID
put
Update tenant app version by ID
del
Delete tenant app version by ID
Apple App Store
get
Search Apple App Store
App List
get
Get unified list of iOS apps (IPAs and Webclips) for a tenant
Webclips
post
Create webclip for a tenant
get
Get webclips for a tenant
get
Get webclip by id for a tenant
del
Delete webclip for a tenant
COMMANDS
Command Request
get
List command requests
post
Create a command request
get
Get a command request
get
Get stats of a command request
Command Status
get
Get status list for command request
get
Get a command status
put
Update command status
get
Get Queued commands to be executed by the physical device
DRIFT
Converge
get
List converge action
post
Create a converge action
get
Get converge action
Converge Command
get
List commands fires for converge action
DEVICE ONBOARDING
DEP Sync Request
get
List all DEP sync requests for the tenant
post
Create a DEP sync request
get
Get a DEP sync request
ABM Provisioning
post
Create a ABM provisioning request by uploading file
post
Create a ABM provisioning request using device serial number
TENANT
APNs certificate
get
Get all APNs certificate meta data for the Tenant
post
Get the CSR file to upload to the apple identity console
get
Get APNs certificate meta information
put
Upload APNs certificate
del
Delete a APNs certificate
DEP Tokens
post
Generate the public key file
get
Get all DEP tokens
get
Get dep token by id
put
Upload dep token to a tenant
VPP Token Management
get
Get all VPP tokens for the tenant
post
Store a VPP token
del
Delete VPP Token
Google Enterprise
post
Generate sign-up URL
get
Return the enrollment status of the Enterprise
post
Create a Google Web Token
post
Complete EMM enrollment for a Google Enterprise
get
Return the Google Service Account of the Enterprise
FOUNDATION
FoundryBuilds
get
Get Foundry builds
get
Get Foundry Build
put
Update Foundry build
FoundryDeviceModels
get
Get device models
put
Update Tenant Device Model
FoundryEvents
get
Get Foundry events
REPORTS
Reports API
get
Get report types
post
Create Report
get
Get report status
System Status Code
System status code descriptions
900 (INTERNAL_REQUEST_SKIPPED) - Response code is used when a request is valid, but cannot be fulfilled.
➔ Next to
System