minimusdocs
Help center

Servers

Get the load history of servers

GET/instances/servers/metrics/

read Read: looks, changes nothing. Scopes

CPU, memory, network, streams and viewers over range, in time buckets (1 minute for 1h up to 2 hours for 30d; at most 360 points, oldest first). With server, that server's figures; without, all servers together (CPU averaged, the rest added up). A bucket with no sample is left out, so a chart shows a gap. Panel operators only.

Query parameters

  • rangestring

    How far back to look. Sets the bucket width too.

    • 1h - 1h
    • 6h - 6h
    • 24h - 24h
    • 7d - 7d
    • 30d - 30d

    One of: "1h" "6h" "24h" "7d" "30d"

    Default: "1h"

  • serverstring (uuid)

    One server's id. Omit for the whole fleet.

Response

200 OK

  • rangestringrequired
    • 1h - 1h
    • 6h - 6h
    • 24h - 24h
    • 7d - 7d
    • 30d - 30d

    One of: "1h" "6h" "24h" "7d" "30d"

  • bucket_secondsintegerrequired
  • retention_daysintegerrequired

    How many days of history the panel keeps (Settings → Panel).

  • pointsobject[]required
    • tstring (date-time)required

      Start of the bucket, UTC.

    • cpu_pctnumberrequiredcan be null
    • ram_pctnumberrequiredcan be null
    • ram_used_bytesintegerrequiredcan be null
    • ram_total_bytesintegerrequiredcan be null
    • in_bpsintegerrequiredcan be null

      Inbound bits/sec.

    • out_bpsintegerrequiredcan be null

      Outbound bits/sec.

    • streamsintegerrequiredcan be null

      Peak running streams in the bucket.

    • sessionsintegerrequiredcan be null

      Peak viewer sessions in the bucket.

Errors

  • 400 Unknown range, or server is not a server id.
  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 404 No server has that id.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means