APIs to view and manage command requests. Learn more about commands or how to schedule a command.
Scheduled commands are currently compatible with Android devices.
API to get and filter command requests
Command request list for the Tenant
Authorization information is missing or invalid.
Internal server error
{- "code": 0,
- "message": "string",
- "content": {
- "count": 0,
- "previous": "string",
- "next": "string",
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "command_type": "DEVICE",
- "devices": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "groups": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "device_type": "active",
- "command": "ADD_TO_WHITELIST",
- "command_args": {
- "device_alias_name": "string",
- "custom_settings_config": { },
- "app_version": "string",
- "package_name": "string",
- "policy_url": "string",
- "wifi_access_points": { },
- "state": "string",
- "message": "string",
- "title": "string",
- "url": "string",
- "app_state": "string",
- "bluetooth_state": true,
- "brightness_value": 0,
- "gps_state": 0,
- "rotate_state": 0,
- "screen_off_timeout": 0,
- "stream": 0,
- "volume_level": 0,
- "timezone_string": 0,
- "wifi_state": true,
- "wifi_revert_timeout": 0,
- "locale": "string",
- "ethernet_auth_mode": "NONE",
- "ethernet_ca_cert_alias": "string",
- "ethernet_client_cert_alias": "string",
- "ethernet_eap_identity": "string",
- "interface": "string",
- "dhcp_enabled": "string",
- "static_ip": "string",
- "primary_dns": "string",
- "subnet_mask": "string",
- "secondary_dns": "string",
- "gateway": "string",
- "duration": "string",
- "video_quality": "HIGH",
- "enable_debug_mode": false,
- "app_id": "string",
- "bundle_identifier": "string",
- "managed_only": true,
- "profile_identifier": "string",
- "profile": "string",
- "is_converge": true,
- "script": "string",
- "interpreter": "string",
- "executed_as": "string",
- "expected_return_value": "string",
- "timeout": "string",
- "working_directory": "string",
- "dependencies": "string",
- "cert_file_type": "string",
- "cert_data_base64": "string",
- "cert_alias_name": "string",
- "cert_storage_type": "string",
- "cert_password": "string",
- "webclip_id": "string"
}, - "schedule": "IMMEDIATE",
- "schedule_args": {
- "name": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "time_type": "console",
- "window_start_time": "string",
- "window_end_time": "string",
- "days": [
- "string"
]
}, - "reason": "string",
- "created_by": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
]
}
}
API to create a command request for a set of devices or groups. Works for mixed-fleet devices (Android, iOS, etc.) if the command is supported.
You can send the command immediately or schedule command for supported devices.
Scheduled commands are currently compatible with Android devices.
Command request successfully created.
Bad request
Authorization information is missing or invalid.
Internal server error
{- "command_type": "DEVICE",
- "alias": "string",
- "devices": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "groups": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "device_type": "active",
- "command": "ADD_TO_WHITELIST",
- "command_args": {
- "device_alias_name": "string",
- "custom_settings_config": { },
- "app_version": "string",
- "package_name": "string",
- "policy_url": "string",
- "wifi_access_points": { },
- "state": "string",
- "message": "string",
- "title": "string",
- "url": "string",
- "app_state": "string",
- "bluetooth_state": true,
- "brightness_value": 0,
- "gps_state": 0,
- "rotate_state": 0,
- "screen_off_timeout": 0,
- "stream": 0,
- "volume_level": 0,
- "timezone_string": 0,
- "wifi_state": true,
- "wifi_revert_timeout": 0,
- "locale": "string",
- "ethernet_auth_mode": "NONE",
- "ethernet_ca_cert_alias": "string",
- "ethernet_client_cert_alias": "string",
- "ethernet_eap_identity": "string",
- "interface": "string",
- "dhcp_enabled": "string",
- "static_ip": "string",
- "primary_dns": "string",
- "subnet_mask": "string",
- "secondary_dns": "string",
- "gateway": "string",
- "duration": "string",
- "video_quality": "HIGH",
- "enable_debug_mode": false,
- "app_id": "string",
- "bundle_identifier": "string",
- "managed_only": true,
- "profile_identifier": "string",
- "profile": "string",
- "is_converge": true,
- "script": "string",
- "interpreter": "string",
- "executed_as": "string",
- "expected_return_value": "string",
- "timeout": "string",
- "working_directory": "string",
- "dependencies": "string",
- "cert_file_type": "string",
- "cert_data_base64": "string",
- "cert_alias_name": "string",
- "cert_storage_type": "string",
- "cert_password": "string",
- "webclip_id": "string"
}, - "schedule": "IMMEDIATE",
- "schedule_args": {
- "name": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "time_type": "console",
- "window_start_time": "string",
- "window_end_time": "string",
- "days": [
- "string"
]
}
}
{- "code": 0,
- "message": "string",
- "content": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "command_type": "DEVICE",
- "devices": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "groups": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "device_type": "active",
- "command": "ADD_TO_WHITELIST",
- "command_args": {
- "device_alias_name": "string",
- "custom_settings_config": { },
- "app_version": "string",
- "package_name": "string",
- "policy_url": "string",
- "wifi_access_points": { },
- "state": "string",
- "message": "string",
- "title": "string",
- "url": "string",
- "app_state": "string",
- "bluetooth_state": true,
- "brightness_value": 0,
- "gps_state": 0,
- "rotate_state": 0,
- "screen_off_timeout": 0,
- "stream": 0,
- "volume_level": 0,
- "timezone_string": 0,
- "wifi_state": true,
- "wifi_revert_timeout": 0,
- "locale": "string",
- "ethernet_auth_mode": "NONE",
- "ethernet_ca_cert_alias": "string",
- "ethernet_client_cert_alias": "string",
- "ethernet_eap_identity": "string",
- "interface": "string",
- "dhcp_enabled": "string",
- "static_ip": "string",
- "primary_dns": "string",
- "subnet_mask": "string",
- "secondary_dns": "string",
- "gateway": "string",
- "duration": "string",
- "video_quality": "HIGH",
- "enable_debug_mode": false,
- "app_id": "string",
- "bundle_identifier": "string",
- "managed_only": true,
- "profile_identifier": "string",
- "profile": "string",
- "is_converge": true,
- "script": "string",
- "interpreter": "string",
- "executed_as": "string",
- "expected_return_value": "string",
- "timeout": "string",
- "working_directory": "string",
- "dependencies": "string",
- "cert_file_type": "string",
- "cert_data_base64": "string",
- "cert_alias_name": "string",
- "cert_storage_type": "string",
- "cert_password": "string",
- "webclip_id": "string"
}, - "schedule": "IMMEDIATE",
- "schedule_args": {
- "name": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "time_type": "console",
- "window_start_time": "string",
- "window_end_time": "string",
- "days": [
- "string"
]
}, - "reason": "string",
- "created_by": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
}
API to get a command request
Command request information
Authorization information is missing or invalid.
Not Found.
Internal server error
{- "code": 0,
- "message": "string",
- "content": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "command_type": "DEVICE",
- "devices": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "groups": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "device_type": "active",
- "command": "ADD_TO_WHITELIST",
- "command_args": {
- "device_alias_name": "string",
- "custom_settings_config": { },
- "app_version": "string",
- "package_name": "string",
- "policy_url": "string",
- "wifi_access_points": { },
- "state": "string",
- "message": "string",
- "title": "string",
- "url": "string",
- "app_state": "string",
- "bluetooth_state": true,
- "brightness_value": 0,
- "gps_state": 0,
- "rotate_state": 0,
- "screen_off_timeout": 0,
- "stream": 0,
- "volume_level": 0,
- "timezone_string": 0,
- "wifi_state": true,
- "wifi_revert_timeout": 0,
- "locale": "string",
- "ethernet_auth_mode": "NONE",
- "ethernet_ca_cert_alias": "string",
- "ethernet_client_cert_alias": "string",
- "ethernet_eap_identity": "string",
- "interface": "string",
- "dhcp_enabled": "string",
- "static_ip": "string",
- "primary_dns": "string",
- "subnet_mask": "string",
- "secondary_dns": "string",
- "gateway": "string",
- "duration": "string",
- "video_quality": "HIGH",
- "enable_debug_mode": false,
- "app_id": "string",
- "bundle_identifier": "string",
- "managed_only": true,
- "profile_identifier": "string",
- "profile": "string",
- "is_converge": true,
- "script": "string",
- "interpreter": "string",
- "executed_as": "string",
- "expected_return_value": "string",
- "timeout": "string",
- "working_directory": "string",
- "dependencies": "string",
- "cert_file_type": "string",
- "cert_data_base64": "string",
- "cert_alias_name": "string",
- "cert_storage_type": "string",
- "cert_password": "string",
- "webclip_id": "string"
}, - "schedule": "IMMEDIATE",
- "schedule_args": {
- "name": "string",
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "time_type": "console",
- "window_start_time": "string",
- "window_end_time": "string",
- "days": [
- "string"
]
}, - "reason": "string",
- "created_by": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
}
API to get a aggregrated status for a command request
Aggregrated status information for a command request.
Authorization information is missing or invalid.
Not Found.
Internal server error
{- "code": 0,
- "message": "string",
- "content": {
- "id": "string",
- "status": [
- {
- "state": "Command Queued",
- "total": 0
}
]
}
}