minimusdocs
Help center

Servers

Get a server's load now

GET/instances/servers/{id}/analytics/

read Read: looks, changes nothing. Scopes

The server's latest report: whether it is up, its streams and viewers against its limit, CPU, memory, network traffic (load.bytes_in_rate_bps, load.bytes_out_rate_bps) and version. Figures under load are null until the server has reported them; the history is GET /instances/servers/metrics/?server=<id>. Panel operators only.

Path parameters

  • idstring (uuid)required

    The server's id.

Response

200 OK

  • instance_idstringrequired
  • namestringrequired
  • kindstringrequired
    • panel - panel
    • streaming - streaming

    One of: "panel" "streaming"

  • domainstringrequired
  • public_urlstring (uri)required
  • internal_urlstring (uri)required
  • capabilitiesstring[]required
  • is_enabledbooleanrequired

    Operator switch. False ⇒ drained; LB excludes from new streams.

  • is_healthybooleanrequired

    Last heartbeat passed and the node hasn't been demoted.

  • is_recentbooleanrequired

    True iff last_seen is within the last 2 minutes.

  • serves_streamsbooleanrequired
  • last_seenstring (date-time)requiredcan be null
  • proxiedbooleanrequired

    Whether the server is reached through its web address (Proxied) or directly (Direct).

  • ping_msintegerrequiredcan be null

    Round-trip-ish liveness number derived from now() - last_seen. None when the node has never heartbeated.

  • current_streamsintegerrequired
  • current_sessionsintegerrequired

    Active client sessions (heartbeat-reported).

  • max_streamsintegerrequired
  • versionstringrequired

    The release of the streaming engine the server runs.

  • loadobjectrequired

    The server's load.

    • cpu_pctnumberrequiredcan be null
    • cpu_coresintegerrequiredcan be null
    • ram_pctnumberrequiredcan be null
    • ram_total_bytesintegerrequiredcan be null
    • ram_used_bytesintegerrequiredcan be null
    • bytes_in_totalintegerrequiredcan be null
    • bytes_out_totalintegerrequiredcan be null
    • bytes_in_rate_bpsintegerrequiredcan be null
    • bytes_out_rate_bpsintegerrequiredcan be null
    • uptime_secondsintegerrequiredcan be null
    • pipeline_failures_last_5mintegerrequiredcan be null
    • sweeper_last_pass_age_secsintegerrequiredcan be null
    • engine_stops_in_flightintegerrequiredcan be null

Errors

  • 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 Nothing with this id, or nothing the account can see.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means