Skip to main content
POST
Pull the next command

Authorizations

Authorization
string
header
required

API token created in the dashboard under Integrations > API. Tokens start with gci_.

Path Parameters

serverId
string<uuid>
required
Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

Body

application/json
onlineIdentifiers
string[]

Identifiers of the players online right now, such as nicknames. Up to 4,096 after trimming and lowercasing. Commands that require the player online only run for identifiers in this list.

Example:

Response

The claimed command.

command
string
Example:

"lp user Steve parent add vip"

id
integer<int64>

Queued command id. Report it back with done or fail.

Example:

4512