Skip to content

List recent screen commands

GET
/api/v1/screens/{id}/commands
curl --request GET \
--url https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/commands

Requires an authenticated dashboard user.

id
required
string format: uuid

Command history

Media typeapplication/json
object
data
required
object
items
required
Array<object>
object
id
required
string format: uuid
type
required
string
Allowed values: sync_now reload_playback identify_screen clear_media_cache clear_website_data disable_playback enable_playback install_player_update retry_player_recovery exit_safe_mode power_assist_sleep power_assist_wake retry_current_item skip_current_item recreate_renderer recreate_playback_session restart_activity restart_player_process resynchronize_player run_player_self_test install_autostart remove_autostart prepare_airplay_session stop_airplay_session test_airplay_support display_power_on display_power_off display_set_input display_set_volume display_mute display_unmute display_set_brightness display_probe provision_presentation_network test_presentation_network
payload
required

Per-type command arguments validated at queue time.

object
key
additional properties
any
state
required
string
Allowed values: pending delivered acknowledged running succeeded failed cancelled expired
createdAt
required
string format: date-time
expiresAt
required
string format: date-time
deliveredAt
string | null format: date-time
acknowledgedAt
string | null format: date-time
completedAt
string | null format: date-time
resultCode
string | null
resultMessage
string | null
total
required
integer
Example
{
"data": {
"items": [
{
"type": "sync_now",
"state": "pending"
}
]
}
}