Bring node data into your own systems.

REST API · JSON responses · Token auth — a data interface for panels, service providers and developers.

Overview

The Pi Admin REST API gives programmatic access to node and runtime data. All endpoints use HTTPS and return JSON; authenticate by sending a key in the Authorization header. Keys are issued by the site operator — guard them like a password.

Authentication

Authorization: Bearer <你的密钥>

Quick start

Fetch your first payload with a single curl command:

curl -sS "/api/nodes?page=1&pageSize=20" \
  -H "Authorization: Bearer TOKEN" \
  -H "Accept: application/json"

Core endpoints

GET/api/nodes

Lists the nodes the current user can access, with pagination and status filters.

GET/api/nodes/:id

Returns one node's basic information and current runtime state.

GET/api/nodes/:id/stats

Returns statistics for a node over a given time range.

Error codes

401Missing or invalid key — check the Authorization header

403Insufficient scope — this endpoint needs a higher-privilege key

429Rate limited — reduce request frequency or contact us for a quota increase

5xxServer error — contact us with the request ID

Ready to integrate?

Need a key or the full field definitions? Just get in touch.

Help center Request an API key