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>'
{
  "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",
      "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": "SLOTS"
      },
      "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>"
          ]
        }
      }
    }
  ]
}

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[]