Retrieve executable commands for the authenticated player

GET

/api/v1/player/commands

const url = 'https://example.com/api/v1/player/commands';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/player/commands

Requires an authenticated player credential.

Responses

200

Stable command list

application/json

object

data

required

object

items

required

Array<object>

object

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

idempotencyKey

required

string format: uuid

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

Example

{
  "data": {
    "items": [
      {
        "type": "sync_now",
        "state": "pending"
      }
    ]
  }
}