Apps Domain (1.0.0)

Download OpenAPI specification:Download

This is the public interface of Apps Domain API

VPP License Management

APIs for managing VPP License of apps

Get VPP License List

API to get list of vpp licenses with the given VPP token

SecurityAuthorization
Request
header Parameters
X-Tenant-Id
required
string <uuid>
X-Caller-Id
required
string
X-SCAPI-Private-URL
required
string
Responses
200

Success

401

Unauthorized

500

Internal Server Error

get/api/apps/v0/vpp
Request samples 
Response samples 
application/json
{
  • "code": 200,
  • "message": "string",
  • "content": {
    }
}
Get VPP License Info about an App
API to get info of vpp license of the given App


SecurityAuthorization 
Request 
path Parameters
appId
required
integer
 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Success


401
Unauthorized


500
Internal Server Error


get/api/apps/v0/vpp/{appId}
Request samples 
Response samples 
application/json
{
  • "code": 200,
  • "message": "string",
  • "content": {
    }
}
Itunes App Info
APIs for getting info about iOS apps


Get iOS App Info (v2)
API to get information about iOS App based on App ID or Apple App ID


SecurityAuthorization 
Request 
query Parameters
app_id
string <uuid> 
 
apple_app_id
string
 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Success


400
Bad Request


401
Unauthorized


500
Internal Server Error


get/api/v2/itunesapps
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Tenant Apps
API to manage Tenant Apps for a tenant


Upload tenant app for a tenant
SecurityAuthorization 
Request 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
Request Body schema: multipart/form-data
required
platform
string
 Value: "APPLE"  
file
string <binary> 
 
Responses 
200
Success


400
Bad Request


401
Unauthorized


500
Internal Server Error


post/api/v2/tenant-apps
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Get tenant apps for a tenant
SecurityAuthorization 
Request 
query Parameters
limit
number
 
offset
number
 
platform
string
 Value: "APPLE"  
package_name
string
 
app_name
string
 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Success


400
Bad Request


401
Unauthorized


500
Internal Server Error


get/api/v2/tenant-apps
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Get tenant app by ID
SecurityAuthorization 
Request 
path Parameters
appId
required
string <uuid> 
 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
Responses 
200
Success


400
Bad Request


401
Unauthorized


404
Not Found


500
Internal Server Error


get/api/v2/tenant-apps/{appId}
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Get tenant app versions by app ID
SecurityAuthorization 
Request 
path Parameters
appId
required
string <uuid> 
 
query Parameters
limit
number
 
offset
number
 
app_name
string
 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Success


400
Bad Request


401
Unauthorized


500
Internal Server Error


get/api/v2/tenant-apps/{appId}/versions
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Get tenant app version by ID
SecurityAuthorization 
Request 
path Parameters
appId
required
string <uuid> 
 
versionId
required
string <uuid> 
 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
Responses 
200
Success


400
Bad Request


401
Unauthorized


404
Not Found


500
Internal Server Error


get/api/v2/tenant-apps/{appId}/versions/{versionId}
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Update tenant app version by ID
SecurityAuthorization 
Request 
path Parameters
appId
required
string
 
versionId
required
string <uuid> 
 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
Request Body schema: application/json
required
description
string
 
Responses 
200
Success


400
Bad Request


401
Unauthorized


404
Not Found


500
Internal Server Error


put/api/v2/tenant-apps/{appId}/versions/{versionId}
Request samples 
application/json
{
  • "description": "string"
}
Response samples 
application/json
{
  • "content": {
    }
}
Delete tenant app version by ID
SecurityAuthorization 
Request 
path Parameters
appId
required
string <uuid> 
 
versionId
required
string <uuid> 
 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
Responses 
200
Success


400
Bad Request


401
Unauthorized


404
Not Found


500
Internal Server Error


delete/api/v2/tenant-apps/{appId}/versions/{versionId}
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Tenant Esper Apps
API to manage Esper Apps for a tenant


Get esper apps for a tenant
SecurityAuthorization 
Request 
query Parameters
limit
number
 
offset
number
 
package_name
string
 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Success


400
Bad Request


401
Unauthorized


500
Internal Server Error


get/api/v2/tenant-esper-apps
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Command Request
APIs for command request


List command requests
API to get and filter command requests


SecurityAuthorization 
Request 
query Parameters
devices
string
Filter by device IDs. Accepts comma separated values.


 
groups
string
Filter by group IDs. Accepts comma separated values.


 
command
string
Filter by command name


 
schedule
string
Filter by schedule type


 Enum: "IMMEDIATE" "WINDOW" "RECURRING"  
exclude_internal_commands
boolean
 Default:  false
Filter to exclude internal commands


 
limit
number
 
offset
number
 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Command request list for the Tenant


401
Authorization information is missing or invalid.


500
Internal server error


get/api/commands/v0/commands/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Create a command request
API to create a command request for set of devices/groups.


SecurityAuthorization 
Request 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Request Body schema: application/json
required
command_type
string
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"  
devices
Array of strings <uuid>   [ 0 .. 1000 ] items 
List of devices to run commands. Required if command_type is 'DEVICE' or 'DYNAMIC'


 
groups
Array of strings <uuid>   [ 0 .. 500 ] items 
List of groups to run commands. Required if command_type is 'GROUP' or 'DYNAMIC'


 
device_type
string
Type of devices to run commands on


* active: Run commands on currently online devices
* inactive: Run commands on currently offline devices
* all: Run commands on all the devices.
  Commands will be queued for offline devices until they come back online.



 Enum: "active" "inactive" "all"  
command
string (DeviceCommandEnum) 
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
* CONVERGE: Converge command for Blueprint
* 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. 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_MULTI_APP_MODE : Command to set the device back to multi app mode.
* 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 strema 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.
* 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.
* SET_DEVICE_LANGUAGE: Set language for a device. Requires locale value in xx_yy format where xx is language 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`..
* DEVICE_INFORMATION: Prompt device to update the device information
* VPP_APP_INSTALL: Install a vpp app on an iOS device. Requires `app_id` and `bundle_identifier` in command arguments that corresponds to the associate vpp app
* APPLE_APP_UNINSTALL: Uninstall an app on an iOS device. Requires `app_id` and `bundle_identifier` in command arguments that corresponds to the associated app
* CLEAR_PASSCODE: Clear the passcode in a device
* LIST_INSTALLED_PROFILES: Returns a list of all installed profiles on an iOS device.
* INSTALL_PROFILE: Install a profile on an iOS device.
* REMOVE_PROFILE: Remove a profile from an iOS device.



 Enum: "ADD_TO_WHITELIST" "ADD_WIFI_AP" "CLEAR_APP_DATA" "CONVERGE" "INSTALL" "LIST_INSTALLED_PROFILES" "LOCK" "REBOOT" "REMOVE_FROM_WHITELIST" "REMOVE_PROFILE" "REMOVE_WIFI_AP" "SET_APP_PERMISSION" "SET_APP_STATE" "SET_BLUETOOTH_STATE" "SET_BRIGHTNESS_SCALE" "SET_DEVICE_LOCKDOWN_STATE" "SET_GPS_STATE" "SET_KIOSK_APP" "SET_MULTI_APP_MODE" "SET_NEW_POLICY" "SET_ROTATION_STATE" "SET_SCREEN_OFF_TIMEOUT" "SET_STREAM_VOLUME" "SET_TIMEZONE" "SET_WIFI_STATE" "UNINSTALL" "UPDATE_DEVICE_CONFIG" "UPDATE_HEARTBEAT" "UPDATE_LATEST_DPC" "WIPE" "RESET_LOCKSCREEN_PASSWORD" "UPDATE_BLUEPRINT" "NOTIFY_DEVICE" "SET_DEVICE_LANGUAGE" "SET_ETHERNET_SETTINGS" "SET_STATIC_IP" "BEEP_DEVICE" "SET_APP_NOTIFICATIONS" "USE_ONLY_SAVED_WIFI_AP" "DEVICE_INFORMATION" "VPP_APP_INSTALL" "APPLE_APP_UNINSTALL" "CLEAR_PASSCODE" "INSTALL_PROFILE"  
object (Command args) 
 
schedule
string (CommandScheduleEnum) 
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 repeatedly, within given parameters



 Enum: "IMMEDIATE" "WINDOW" "RECURRING"  
object (Command Schedule Arguments) 
 
Responses 
201
Command request successfully created.


400
Bad request


401
Authorization information is missing or invalid.


500
Internal server error


post/api/commands/v0/commands/
Request samples 
application/json
{
  • "command_type": "DEVICE",
  • "devices": [
    ],
  • "groups": [
    ],
  • "device_type": "active",
  • "command": "ADD_TO_WHITELIST",
  • "command_args": {
    },
  • "schedule": "IMMEDIATE",
  • "schedule_args": {
    }
}
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get a command request
API to get a command request


SecurityAuthorization 
Request 
path Parameters
id
required
string
ID of the command request object


 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Command request information


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/api/commands/v0/commands/{id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get stats of a command request
API to get a aggregrated status for a command request


SecurityAuthorization 
Request 
path Parameters
id
required
string
ID of the command request object


 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Aggregrated status information for a command request.


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/api/commands/v0/commands/{id}/stats/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Command Status
APIs for command status


Get status list for command request
API to get and filter command request status


SecurityAuthorization 
Request 
query Parameters
request
string
Filter status result by command request IDs. Accepts comma separated values.


 
device
string
Filter status result by device IDs. Accepts comma separated values.


 
state
string
Filter by command state


 Enum: "Command Queued" "Command Initiated" "Command Acknowledged" "Command In Progress" "Command TimeOut" "Command Success" "Command Failure" "Command Scheduled" "Command Cancelled"  
exclude_internal_commands
boolean
 Default:  false
Filter to exclude internal commands


 
limit
number
 
offset
number
 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Status list for a command request


401
Authorization information is missing or invalid.


500
Internal server error


get/api/commands/v0/status/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get a command status
API to get a command status


SecurityAuthorization 
Request 
path Parameters
id
required
string
ID of the command status object


 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Command status information


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/api/commands/v0/status/{id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Update command status
API to update a command status state


SecurityAuthorization 
Request 
path Parameters
id
required
string
ID of the command status object


 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Request Body schema: application/json
required
state
string
Command state to update


 Value: "Command Cancelled"  
Responses 
200
Command status successfully updated.


400
Bad request


401
Authorization information is missing or invalid.


500
Internal server error


put/api/commands/v0/status/{id}/
Request samples 
application/json
{
  • "state": "Command Cancelled"
}
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Device
APIs to create, access and modify device information.


Get all devices in the tenant
Returns all the devices in the tenant


SecurityAuthorization 
Request 
query Parameters
limit
integer
 
offset
integer
 
ordering
string
 
serial
string
 
udid
string
 
android_version
string
 
ios_version
string
 
ipados_version
string
 
state
string
 
battery_level_gte
string
 
battery_level_lte
string
 
is_gms
boolean
 
active_connection
string
 
group_multi
string <uuid> 
 
group_multi_immediate
string <uuid> 
 
assigned_blueprint_id
string <uuid> 
 
current_blueprint_id
string <uuid> 
 
current_blueprint_version_id
string <uuid> 
 
current_blueprint_version_id_net
string <uuid> 
 
platform
string
 Enum: "ANDROID" "APPLE"  
os
string
 Enum: "iOS" "iPadOS" "Android"  
device_source
string
a csv list of device sources [ABM, NON_ABM]


 
search
string
Search devices by multiOS -> name, serial, imei, model. Apple -> udid. Android -> iccid, phone number, brand, wifi, manufacturer, hardware


 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Device information for the Tenant


401
Authorization information is missing or invalid.


500
Internal Server Error


get/api/device/v0/devices/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get details of a Device
SecurityAuthorization 
Request 
path Parameters
id
required
string <uuid> 
ID of the device


 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Details of the device


400
Bad Request


401
Authorization information is missing or invalid.


404
Not found


500
Internal Server Error


get/api/device/v0/devices/{id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Delete a Device. Only supports Apple devices.
SecurityAuthorization 
Request 
path Parameters
id
required
string
ID of the device


 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Details of the device


400
Bad Request


401
Authorization information is missing or invalid.


404
Device not found


500
Internal Server Error


delete/api/device/v0/devices/{id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get details of Current Device State
SecurityAuthorization 
Request 
path Parameters
id
required
string <uuid> 
ID of the device


 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Details of the current device state


400
Bad Request


401
Authorization information is missing or invalid.


404
Not found


500
Internal Server Error


get/api/device/v0/devices/{id}/devicestate
Request samples 
Response samples 
application/json
{
  • "gps_state": "LOCATION_MODE_HIGH_ACCURACY",
  • "wifi_state": true,
  • "adb_enabled": true,
  • "adb_timeout": 0,
  • "remote_adb_enabled": true,
  • "remote_adb_ip": "string",
  • "remote_adb_port": 0,
  • "audio_settings": { },
  • "rotation_state": "AUTO",
  • "bluetooth_state": true,
  • "brightness_scale": 0,
  • "screen_off_timeout": 0,
  • "use_only_saved_ap": true
}
Device Heartbeat
APIs to create, access and modify device heartbeat records.


Get last seen of a Device. Only supports Apple devices.
SecurityAuthorization 
Request 
path Parameters
id
required
string <uuid> 
ID of the device


 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
Responses 
200
Last seen details of the device


400
Device create error - Bad Request


401
Authorization information is missing or invalid.


404
Not found


500
Internal Server Error


get/api/device/v0/heartbeat/{id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get list of heartbeat details for devices
SecurityAuthorization 
Request 
query Parameters
last_seen_gt
required
string <date> 
Specify the starting date and time for device lookup in the format (2023-08-30T00:00:00.000Z).


 
last_seen_lt
required
string <date> 
Specify the end date and time for device lookup in the format (2023-08-30T00:00:00.000Z).


 
platform
string
platform of the device


 Enum: "ANDROID" "APPLE"  
limit
integer
 
offset
integer
 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
Responses 
200
Last seen details of the device


400
Device create error - Bad Request


401
Authorization information is missing or invalid.


500
Internal Server Error


get/api/device/v2/heartbeat/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Device Apps
APIs to get apps installed on devices


Get all apps for a device in the tenant
Returns all the apps for a device


SecurityAuthorization 
Request 
path Parameters
deviceId
required
string
ID of the device


 
query Parameters
app type
string
App Type to filter list by


 Enum: "VPP" "TENANT_IOS" "ESPER_IOS"  
limit
integer
 
offset
integer
 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Success


400
Bad Request


401
Authorization information is missing or invalid.


500
Internal Server Error


get/api/v2/devices/{deviceId}/device-apps/
Request samples 
Response samples 
application/json
{
  • "results": [
    ]
}
Get list of devices with an app by app_id or app_version_id.
SecurityAuthorization 
Request 
query Parameters
app_id
required
integer <uuid> 
 
app_version_id
required
integer <uuid> 
 
header Parameters
X-Tenant-Id
required
string <uuid> 
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Success


400
Bad Request


401
Authorization information is missing or invalid.


500
Internal Server Error


get/api/v2/device-apps
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "prev": "string",
  • "next": "string",
  • "results": [
    ]
}
Health Check
API to check if the service is up and running


Converge
API for converge


List converge action
API to get and filter converge action


SecurityAuthorization 
Request 
query Parameters
device_ids
string
Filter by device IDs. Accepts comma separated values.


 
limit
number
 
offset
number
 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
Converge action list for the Tenant


401
Authorization information is missing or invalid.


500
Internal server error


get/api/v2/converge
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Create a converge action
API to create a converge action for a device.


SecurityAuthorization 
Request 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Request Body schema: application/json
required
device_id
required
string <uuid> 
ID of the device


 
converge_with_provision_option
required
boolean
 
schedule_type
string (ScheduleEnum) 
Following Schedule types are supported


* WINDOW: Schedule the command to execute within the given window ```



 Enum: "IMMEDIATE" "WINDOW"  
schedule_args
object
 
Responses 
201
Converge action successfully created.


400
Bad request


401
Authorization information is missing or invalid.


500
Internal server error


post/api/v2/converge
Request samples 
application/json
{
  • "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
  • "converge_with_provision_option": true,
  • "schedule_type": "IMMEDIATE",
  • "schedule_args": { }
}
Response samples 
application/json
{
  • "content": {
    }
}
Get converge action
API to get a converge action


SecurityAuthorization 
Request 
path Parameters
id
required
string
ID of the converge object


 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
Responses 
200
Converge information


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/api/v2/converge/{id}
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Converge Command
API for converge command


List commands fires for converge action
API to get and filter commands fired for converge action


SecurityAuthorization 
Request 
path Parameters
id
required
string
ID of the converge object


 
query Parameters
limit
number
 
offset
number
 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
List of commands fired for converge action for the tenant


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/api/v2/converge/{id}/commands
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
DEP Sync Request
APIs to create and access DEP sync request information.


List all DEP sync requests for the tenant
Returns all the DEP sync requests for the tenant


SecurityAuthorization 
Request 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
Responses 
200
DEP sync request list for the Tenant


401
Authorization information is missing or invalid.


500
Internal server error


get/api/onboarding/v0/depsyncs/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Create a DEP sync request
API to create a DEP sync request.


SecurityAuthorization 
Request 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Request Body schema: application/json
required
object
 
Responses 
200
DEP sync request successfully created.


400
Bad request


401
Authorization information is missing or invalid.


500
Internal server error


post/api/onboarding/v0/depsyncs/
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get a DEP sync request
API to get a DEP sync request


SecurityAuthorization 
Request 
path Parameters
id
required
string
ID of the DEP sync request object


 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
Responses 
200
DEP sync request information


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/api/onboarding/v0/depsyncs/{id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Seamless Provisioning
APIs to perform seamless provisioning


Create a seamless provisioning request
SecurityAuthorization 
Request 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
Request Body schema: multipart/form-data
required
csv_file
string <binary> 
 
Responses 
200
Seamless provisioning request successfully created.


400
Bad request


401
Authorization information is missing or invalid.


500
Internal server error


post/api/v2/seamless/upload
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Create a seamless provisioning request
SecurityAuthorization 
Request 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
Request Body schema: application/json
required
assigned_blueprint_id
string <uuid> 
 
group_id
string <uuid> 
 
object (SeamlessInfo) 
 
Responses 
200
Seamless request successfully created.


400
Bad request


401
Authorization information is missing or invalid.


500
Internal server error


post/api/v2/seamless
Request samples 
application/json
{
  • "assigned_blueprint_id": "3e41fd18-d53d-4673-a10a-23089cbb6b73",
  • "group_id": "3e41fd18-d53d-4673-a10a-23089cbb6b73",
  • "seamless_info": {
    }
}
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
APNs certificate
APIs for APNs certificate


Get all APNs certificate meta data for the Tenant
Returns all the APNs certificate meta information


SecurityAuthorization 
Request 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
Responses 
200
APNs certificate meta data list for the Tenant


401
Authorization information is missing or invalid.


500
Internal server error


get/api/tenant/v0/apnscertificates/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get the CSR file to upload to the apple identity console
SecurityAuthorization 
Request 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Request Body schema: application/json
required
object
 
Responses 
200
Created


400
Bad request


401
Authorization information is missing or invalid.


500
Internal server error


post/api/tenant/v0/apnscertificates/
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "code": 400,
  • "message": "string",
  • "content": { }
}
Get APNs certificate meta information
SecurityAuthorization 
Request 
path Parameters
id
required
string
ID of the APNs certificate meta object


 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
Responses 
200
APNs certificate meta information


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/api/tenant/v0/apnscertificates/{id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Upload APNs certificate
Upload the signed APNs certificate obtained from the apple identity console.


SecurityAuthorization 
Request 
path Parameters
id
required
string
ID of the APNs certificate meta object


 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Request Body schema: multipart/form-data
required
file
required
string <binary> 
 
apple_id
required
string
 
Responses 
200
Uploaded APNs certificate meta Information


400
APNs certificate update error


401
APNs certificate update error


404
Not Found.


500
Internal server error


put/api/tenant/v0/apnscertificates/{id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Delete a APNs certificate
SecurityAuthorization 
Request 
path Parameters
id
required
string
ID of the APNs certificate meta object


 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
Responses 
204
Deleted APNs certificate


401
APNs certificate delete error


404
Not Found.


500
Internal server error


delete/api/tenant/v0/apnscertificates/{id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": { }
}
DEP Tokens
APIs to create and access DEP Tokens.


Generate the public key file
Generate the public key file which is uploaded to Apple Business Manager(ABM) console to generate the DEP token.


SecurityAuthorization 
Request 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
Request Body schema: application/json
optional
object (DEP_Token_POST) 
 
Responses 
200
Public key generation for ABM


400
Public key generation error - Bad Request


401
Public key generation error - Unauthorized


500
Public key generation error - Internal Server Error


post/api/tenant/v0/deptokens/
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "code": 400,
  • "message": "string",
  • "content": { }
}
Get all DEP tokens
Get the list of all DEP tokens available in the tenant


SecurityAuthorization 
Request 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
Responses 
200
Lists all dep tokens for a tenant


401
Get DEP tokens error - Unauthorized


500
Get DEP tokens error - Internal Server Error


get/api/tenant/v0/deptokens/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get dep token by id
Retrive information of a DEP token by ID


SecurityAuthorization 
Request 
path Parameters
id
required
string <UUID> 
ID of the token object


 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
Responses 
200
Get DEP token by id


401
Get DEP token by id error - Unauthorized


404
Not Found


500
Get DEP token by id error - Internal Server Error


get/api/tenant/v0/deptokens/{id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Upload dep token to a tenant
Upload dep token for a public key for a tenant based on ID of DEP public key


SecurityAuthorization 
Request 
path Parameters
id
required
string <UUID> 
ID of the token object


 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
Request Body schema: multipart/form-data
required
file
required
string <binary> 
.p7m file from abm console


 
token_name
required
string
 
Responses 
200
Upload dep token for a public key by id


400
Upload DEP token by id error - Bad Request


401
Upload DEP token by id error - Unauthorized


404
Not Found


500
Upload DEP token by id error - Internal Server Error


put/api/tenant/v0/deptokens/{id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
VPP Token Management
APIs to create, access and delete VPP tokens for a tenant.


Get all VPP tokens for the tenant
Returns all the VPP tokens for the tenant


SecurityAuthorization 
Request 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
X-SCAPI-Private-URL
required
string
 
Responses 
200
VPP tokens for the Tenant


401
Unauthorized


500
Internal Server Error


get/api/tenant/v0/vpptokens/
Request samples 
Response samples 
application/json
{
  • "code": 200,
  • "message": "string",
  • "content": {
    }
}
Store a VPP token
Uploads a VPP token


SecurityAuthorization 
Request 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
Request Body schema: multipart/form-data
filename
string <binary> 
 
Responses 
201
Created


400
Bad Request


401
Unauthorized


500
Internal Server Error


post/api/tenant/v0/vpptokens/
Request samples 
Response samples 
application/json
{
  • "code": 201,
  • "message": "string",
  • "content": {
    }
}
Delete VPP Token
API to delete vpp token for a tenant


SecurityAuthorization 
Request 
path Parameters
id
required
integer
 
header Parameters
X-Tenant-Id
required
string
 
X-Caller-Id
required
string
 
Responses 
204
Success


401
Unauthorized


404
Resource Not Found


500
Internal Server Error


delete/api/tenant/v0/vpptokens/{id}
Request samples 
Response samples 
application/json
{
  • "code": 204,
  • "message": "string",
  • "content": { }
}