Servers API

Server object

{
  "id": "srv_01HXZ3M...",
  "name": "prod-web-01",
  "hostname": "prod-web-01.example.com",
  "ip": "93.184.216.34",
  "os": "Ubuntu 22.04.3 LTS",
  "kernel": "6.2.0-36-generic",
  "status": "online",
  "agent_version": "1.4.2",
  "last_seen_at": "2025-01-15T10:29:45Z",
  "metrics": {
    "cpu_percent": 24.5,
    "mem_used_percent": 61.2,
    "disk_used_percent": 48.7,
    "load_1": 0.82,
    "load_5": 0.91,
    "load_15": 0.88,
    "net_bytes_recv_rate": 1024000,
    "net_bytes_sent_rate": 512000,
    "updated_at": "2025-01-15T10:29:45Z"
  },
  "created_at": "2024-10-01T08:00:00Z"
}

List servers

GET /v1/servers

curl https://api.securecheap.com/v1/servers \
  -H "Authorization: Bearer sc_live_xxxx"

Get server metrics history

GET /v1/servers/{id}/metrics

Query parameters:

Parameter	Type	Default	Description
`from`	ISO 8601	1 hour ago	Start of time range
`to`	ISO 8601	now	End of time range
`resolution`	string	`auto`	`raw`, `1m`, `5m`, `1h`
`metrics`	string	all	Comma-separated metric names

curl "https://api.securecheap.com/v1/servers/srv_01HXZ3M/metrics?from=2025-01-15T09:00:00Z&resolution=5m&metrics=cpu_percent,mem_used_percent" \
  -H "Authorization: Bearer sc_live_xxxx"

Response:

{
  "data": {
    "server_id": "srv_01HXZ3M...",
    "resolution": "5m",
    "series": {
      "cpu_percent": [
        { "t": "2025-01-15T09:00:00Z", "v": 18.2 },
        { "t": "2025-01-15T09:05:00Z", "v": 22.7 },
        { "t": "2025-01-15T09:10:00Z", "v": 31.4 }
      ],
      "mem_used_percent": [
        { "t": "2025-01-15T09:00:00Z", "v": 58.1 },
        { "t": "2025-01-15T09:05:00Z", "v": 58.4 },
        { "t": "2025-01-15T09:10:00Z", "v": 59.2 }
      ]
    }
  }
}

Monitors Alerts