Player Group

Trigger players action by group

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/group/action

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

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

actionstringqueryrequired

player action (checkin, clearcache, hideid, playerlog, reboot, screenshot or showid)

Example: checkin

namestringquery

full or partial player group name

Example: sample_group

idstringquery

id of the player group

tagstringquery

search tag

Response

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

Still need help? Share an idea