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 '
{
"persistent_server_id": "123e4567-e89b-12d3-a456-426614174000",
"selection_mode": "RANDOM",
"server_group_id": "123e4567-e89b-12d3-a456-426614174000",
"server_id": "lobby-1"
}
'import requests
url = "https://controller.platform.simplecloud.app/v0/players/connect"
payload = {
"persistent_server_id": "123e4567-e89b-12d3-a456-426614174000",
"selection_mode": "RANDOM",
"server_group_id": "123e4567-e89b-12d3-a456-426614174000",
"server_id": "lobby-1"
}
headers = {
"X-Network-ID": "<x-network-id>",
"X-Network-Secret": "<x-network-secret>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Network-ID': '<x-network-id>',
'X-Network-Secret': '<x-network-secret>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
persistent_server_id: '123e4567-e89b-12d3-a456-426614174000',
selection_mode: 'RANDOM',
server_group_id: '123e4567-e89b-12d3-a456-426614174000',
server_id: 'lobby-1'
})
};
fetch('https://controller.platform.simplecloud.app/v0/players/connect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://controller.platform.simplecloud.app/v0/players/connect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'persistent_server_id' => '123e4567-e89b-12d3-a456-426614174000',
'selection_mode' => 'RANDOM',
'server_group_id' => '123e4567-e89b-12d3-a456-426614174000',
'server_id' => 'lobby-1'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Network-ID: <x-network-id>",
"X-Network-Secret: <x-network-secret>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://controller.platform.simplecloud.app/v0/players/connect"
payload := strings.NewReader("{\n \"persistent_server_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"selection_mode\": \"RANDOM\",\n \"server_group_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"server_id\": \"lobby-1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Network-ID", "<x-network-id>")
req.Header.Add("X-Network-Secret", "<x-network-secret>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://controller.platform.simplecloud.app/v0/players/connect")
.header("X-Network-ID", "<x-network-id>")
.header("X-Network-Secret", "<x-network-secret>")
.header("Content-Type", "application/json")
.body("{\n \"persistent_server_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"selection_mode\": \"RANDOM\",\n \"server_group_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"server_id\": \"lobby-1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://controller.platform.simplecloud.app/v0/players/connect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Network-ID"] = '<x-network-id>'
request["X-Network-Secret"] = '<x-network-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"persistent_server_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"selection_mode\": \"RANDOM\",\n \"server_group_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"server_id\": \"lobby-1\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Connect request sent",
"player_id": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
"server_name": "lobby-1",
"success": true
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}players
Connect player to server
Connect a player to a specific server, server group, or persistent server
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 '
{
"persistent_server_id": "123e4567-e89b-12d3-a456-426614174000",
"selection_mode": "RANDOM",
"server_group_id": "123e4567-e89b-12d3-a456-426614174000",
"server_id": "lobby-1"
}
'import requests
url = "https://controller.platform.simplecloud.app/v0/players/connect"
payload = {
"persistent_server_id": "123e4567-e89b-12d3-a456-426614174000",
"selection_mode": "RANDOM",
"server_group_id": "123e4567-e89b-12d3-a456-426614174000",
"server_id": "lobby-1"
}
headers = {
"X-Network-ID": "<x-network-id>",
"X-Network-Secret": "<x-network-secret>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Network-ID': '<x-network-id>',
'X-Network-Secret': '<x-network-secret>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
persistent_server_id: '123e4567-e89b-12d3-a456-426614174000',
selection_mode: 'RANDOM',
server_group_id: '123e4567-e89b-12d3-a456-426614174000',
server_id: 'lobby-1'
})
};
fetch('https://controller.platform.simplecloud.app/v0/players/connect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://controller.platform.simplecloud.app/v0/players/connect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'persistent_server_id' => '123e4567-e89b-12d3-a456-426614174000',
'selection_mode' => 'RANDOM',
'server_group_id' => '123e4567-e89b-12d3-a456-426614174000',
'server_id' => 'lobby-1'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Network-ID: <x-network-id>",
"X-Network-Secret: <x-network-secret>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://controller.platform.simplecloud.app/v0/players/connect"
payload := strings.NewReader("{\n \"persistent_server_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"selection_mode\": \"RANDOM\",\n \"server_group_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"server_id\": \"lobby-1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Network-ID", "<x-network-id>")
req.Header.Add("X-Network-Secret", "<x-network-secret>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://controller.platform.simplecloud.app/v0/players/connect")
.header("X-Network-ID", "<x-network-id>")
.header("X-Network-Secret", "<x-network-secret>")
.header("Content-Type", "application/json")
.body("{\n \"persistent_server_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"selection_mode\": \"RANDOM\",\n \"server_group_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"server_id\": \"lobby-1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://controller.platform.simplecloud.app/v0/players/connect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Network-ID"] = '<x-network-id>'
request["X-Network-Secret"] = '<x-network-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"persistent_server_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"selection_mode\": \"RANDOM\",\n \"server_group_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"server_id\": \"lobby-1\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Connect request sent",
"player_id": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
"server_name": "lobby-1",
"success": true
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Query Parameters
Player UUID
Body
application/json
Connection target
Was this page helpful?
⌘I