Logo

Device

APIs to create, access and modify device information.

Get all devices in the tenant

Returns all the devices in the tenant

SecurityapiKey03
Request
query Parameters
limit
integer
offset
integer
ordering
string

Field to order the results by. Prefix with '-' to reverse the order.

Enum: "alias" "created_at" "last_seen" "model" "os_version" "name" "onboarded_on" "serial" "provisioned_on" "battery_level" "dpc_version" "eea_version" "is_gms" "security_state" "wifi_ssid" "platform"
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

foundation_device_model_id
string <uuid>
android_version_exact
string
foundation_major_version
integer
foundation_minor_version
integer
foundation_build_number
integer
Responses
200

Device information for the Tenant

401

Authorization information is missing or invalid.

500

Internal Server Error

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


 
Responses 
200
Details of the device


400
Bad Request


401
Authorization information is missing or invalid.


404
Not found


500
Internal Server Error


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


 
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/device/v0/devices/{id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get details of Current Device State
SecurityapiKey03 
Request 
path Parameters
id
required
string <uuid> 
ID of the device


 
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/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
}
➔ Next to Device Heartbeat