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>'
import requests

url = "https://controller.platform.simplecloud.app/v0/stats"

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/stats', 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/stats",
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/stats"

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/stats")
.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/stats")

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
{
  "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
  }
}
{
"error": "<string>"
}
{
"error": "<string>"
}
{
"error": "<string>"
}

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