Player

Trigger player action

Can be used to trigger an early checkin, reboot or any of the allowed player actions. (Invalid actions will be ignored by the players)

PUT

/api/v1/player/action

curl --request PUT \
  --url 'https://voyager.korbyt.com/api/v1/player/action?name=sample_player&id=%3Cstring%3E&tag=%3Cstring%3E&status=%3Cstring%3E&action=checkin' \
  --header 'Authorization: Bearer <token>'

Authorizations

Authorizationstringheaderrequired

Access token from POST /api/v1/auth/login

Query Parameters

namestringquery

Player name

Example: sample_player

idstringquery

Player id

tagstringquery

Player tag

statusstringquery

Player status

actionstringqueryrequired

the player action to be triggered. supported actions are checkin clearcache hideid playerlog reboot screenshot showid

Example: checkin

Response

Success. Response body is not documented in the source collection.

Still need help? Share an idea