Skip to main content
POST
/
v0
/
players
/
connect
Connect player to server
curl --request POST \
  --url https://controller.platform.simplecloud.app/v0/players/connect \
  --header 'Content-Type: application/json' \
  --header 'X-Network-ID: <x-network-id>' \
  --header 'X-Network-Secret: <x-network-secret>' \
  --data '{}'
{
  "message": "Connect request sent",
  "player_id": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
  "server_name": "lobby-1",
  "success": true
}

Documentation Index

Fetch the complete documentation index at: https://new-docs.simplecloud.app/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
X-Network-ID
string
required

Network ID

​
X-Network-Secret
string
required

Network Secret

Query Parameters

​
player_id
string
required

Player UUID

Body

application/json

Connection target

The body is of type object.

Response

OK

Response for connecting a player

​
message
string
Example:

"Connect request sent"

​
player_id
string
Example:

"069a79f4-44e9-4726-a5be-fca90e38aaf5"

​
server_name
string
Example:

"lobby-1"

​
success
boolean
Example:

true