Skip to main content
GET
/
v0
/
players
/
online
List online players
curl --request GET \
  --url https://controller.platform.simplecloud.app/v0/players/online \
  --header 'X-Network-ID: <x-network-id>' \
  --header 'X-Network-Secret: <x-network-secret>'
{
  "count": 100,
  "players": [
    {
      "connected_proxy_name": "proxy-1",
      "connected_server_name": "lobby-1",
      "display_name": "Steve",
      "id": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
      "name": "Steve"
    }
  ]
}

Headers

X-Network-ID
string
required

Network ID

X-Network-Secret
string
required

Network Secret

Query Parameters

server
string

Filter by connected server

Response

OK

Response for listing online players

count
integer
Example:

100

players
object[]