Skip to main content
GET
/
v0
/
stats
Get cloud statistics
curl --request GET \
  --url https://controller.platform.simplecloud.app/v0/stats \
  --header 'X-Network-ID: <x-network-id>' \
  --header 'X-Network-Secret: <x-network-secret>'
{
  "health": {
    "healthy_server_percent": 123,
    "status": "<string>"
  },
  "persistent_servers": {
    "active": 123,
    "total": 123
  },
  "players": {
    "capacity": 123,
    "online": 123,
    "utilization_percent": 123
  },
  "resources": {
    "average_cpu_percent": 123,
    "memory_allocated_mb": 123,
    "memory_used_mb": 123
  },
  "server_groups": {
    "active": 123,
    "total": 123
  },
  "serverhosts": {
    "active": 123,
    "total": 123,
    "total_memory_capacity_mb": 123
  },
  "servers": {
    "active": 123,
    "by_state": {
      "available": 123,
      "ingame": 123,
      "preparing": 123,
      "queued": 123,
      "starting": 123,
      "stopped": 123,
      "stopping": 123
    },
    "total": 123
  }
}

Headers

X-Network-ID
string
required

Network ID

X-Network-Secret
string
required

Network Secret

Response

OK

health
object
persistent_servers
object
players
object
resources
object
server_groups
object
serverhosts
object
servers
object