Skip to main content
GET
/
v0
/
metrics
/
query
Query current metric values
curl --request GET \
  --url https://controller.platform.simplecloud.app/v0/metrics/query \
  --header 'X-Network-ID: <x-network-id>' \
  --header 'X-Network-Secret: <x-network-secret>'
{
  "samples": [
    {
      "labels": {},
      "metric": "<string>",
      "timestamp": "<string>",
      "value": 123
    }
  ]
}

Headers

​
X-Network-ID
string
required

Network ID

​
X-Network-Secret
string
required

Network Secret

Query Parameters

​
metric
string
required

Metric name (e.g., server.player_count, server.cpu_usage_percent)

​
group_by
string

Label to group by (e.g., server_group_name, persistent_server_name)

​
server_ids
string

Comma-separated server IDs to filter

​
server_group_ids
string

Comma-separated server group IDs to filter

​
persistent_server_ids
string

Comma-separated persistent server IDs to filter

​
server_type
string

Comma-separated server group types to filter (e.g., SERVER, PROXY)

Response

OK

​
samples
object[]