Skip to main content
GET
/
api
/
v3
/
servers
/
{instance_id}
/
metrics
Get server resource metrics
curl --request GET \
  --url https://playflow.dev/api/api/v3/servers/{instance_id}/metrics \
  --header 'api-key: <api-key>'
{
  "instance_id": "<string>",
  "machine_id": "<string>",
  "region": "<string>",
  "period": {
    "start": 123,
    "end": 123,
    "step": "<string>"
  },
  "cpu": {
    "usage_percent": [
      {
        "t": 123,
        "v": 123
      }
    ]
  },
  "memory": {
    "used_mb": [
      {
        "t": 123,
        "v": 123
      }
    ],
    "total_mb": 123
  },
  "network": {
    "rx_bytes_per_sec": [
      {
        "t": 123,
        "v": 123
      }
    ],
    "tx_bytes_per_sec": [
      {
        "t": 123,
        "v": 123
      }
    ]
  },
  "load": {
    "average_1m": [
      {
        "t": 123,
        "v": 123
      }
    ]
  },
  "connections": {
    "tcp": [
      {
        "t": 123,
        "v": 123
      }
    ]
  }
}

Authorizations

api-key
string
header
required

Path Parameters

instance_id
string
required

Server instance ID.

Query Parameters

period
enum<string>
default:1h

Time window for metrics. "5m": last 5 minutes, "15m": last 15 minutes, "1h": last hour, "6h": last 6 hours, "24h": last 24 hours.

Available options:
5m,
15m,
1h,
6h,
24h
step
enum<string>
default:60s

Data point interval. Smaller steps give higher resolution but more data. "15s": every 15 seconds, "30s": every 30 seconds, "60s": every minute (default), "300s": every 5 minutes.

Available options:
15s,
30s,
60s,
300s

Response

Server resource metrics over the requested time window.

Server resource metrics including CPU, memory, network, load, and connections over a configurable time window.

instance_id
string
required

Server instance ID.

machine_id
string
required

Fly.io machine ID providing these metrics.

region
string
required

Fly.io region code (e.g., "ewr", "fra").

period
object
required

Time window and resolution for the returned metrics.

cpu
object
required

CPU usage metrics.

memory
object
required

Memory usage metrics.

network
object
required

Network I/O metrics.

load
object
required

System load average metrics.

connections
object
required

Network connection metrics.