Skip to main content
GET
/
v0
/
server-groups
List server groups
curl --request GET \
  --url https://controller.platform.simplecloud.app/v0/server-groups \
  --header 'X-Network-ID: <x-network-id>' \
  --header 'X-Network-Secret: <x-network-secret>'
import requests

url = "https://controller.platform.simplecloud.app/v0/server-groups"

headers = {
    "X-Network-ID": "<x-network-id>",
    "X-Network-Secret": "<x-network-secret>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
  method: 'GET',
  headers: {'X-Network-ID': '<x-network-id>', 'X-Network-Secret': '<x-network-secret>'}
};

fetch('https://controller.platform.simplecloud.app/v0/server-groups', 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/server-groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://controller.platform.simplecloud.app/v0/server-groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Network-ID", "<x-network-id>")
	req.Header.Add("X-Network-Secret", "<x-network-secret>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://controller.platform.simplecloud.app/v0/server-groups")
  .header("X-Network-ID", "<x-network-id>")
  .header("X-Network-Secret", "<x-network-secret>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://controller.platform.simplecloud.app/v0/server-groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Network-ID"] = '<x-network-id>'
request["X-Network-Secret"] = '<x-network-secret>'

response = http.request(request)
puts response.read_body
{
  "count": 5,
  "server_groups": [
    {
      "active": true,
      "created_at": "2023-01-01T12:00:00Z",
      "deployment": {
        "hosts": [
          {
            "name": "main-host-1",
            "priority": 1
          }
        ],
        "strategy": "whitelist"
      },
      "max_memory": 2048,
      "max_players": 50,
      "min_memory": 1024,
      "name": "lobby",
      "priority": 10,
      "properties": {},
      "scaling": {
        "available_slots": 10,
        "max_servers": 3,
        "min_servers": 0,
        "player_threshold": 0.8,
        "scale_down": {
          "idle_time": "3m",
          "ignore_players": true
        },
        "scaling_mode": "SERVERS"
      },
      "server_group_id": "123e4567-e89b-12d3-a456-426614174000",
      "source": {
        "blueprint": "123e4567-e89b-12d3-a456-426614174000",
        "image": "ghcr.io/user/custom-image:latest",
        "type": "blueprint"
      },
      "stats": {
        "online_players": 42,
        "servers_by_state": {},
        "total_servers": 5
      },
      "tags": [
        "<string>"
      ],
      "type": "SERVER",
      "updated_at": "2023-01-01T12:00:00Z",
      "workflows": {
        "manual": [
          "<string>"
        ],
        "when": {
          "start": [
            "<string>"
          ],
          "stop": [
            "<string>"
          ]
        }
      }
    }
  ]
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}

Headers

X-Network-ID
string
required

Network ID

X-Network-Secret
string
required

Network Secret

Query Parameters

active
boolean

Filter by active status (true/false)

Response

OK

Response for listing server groups

count
integer
Example:

5

server_groups
object[]