Traffic Stats API

If an API secret is set in your configuration, you will need to add the Authorization header when making a request.

Example:

curl -H 'Authorization: secret' http://ip:port/path

GET /traffic

This endpoint returns a JSON map of client IDs to their traffic statistics.

Response:

{
  "wang": {
    "tx": 514,
    "rx": 4017
  },
  "joe": {
    "tx": 7790,
    "rx": 446623
  }
}

You can also use the query parameter clear to zero out the statistics after they are returned:

/traffic?clear=1

POST /kick

This endpoint allows you to kick a list of clients by their IDs.

Request:

["wang", "joe"]

NOTE: Due to the reconnect logic built into the client, it will attempt to reconnect after being kicked. To avoid having to repeatedly kick the same client, you should also block the user in your authentication backend.

GET /online

This endpoint returns a JSON map of online clients to the number of connections they have. The connection count here refers to the number of Hysteria client instances ("devices"), NOT the number of active proxy connections.

Response:

{
  "wang": 2,
  "joe": 1
}

GET /dump/streams

This endpoint returns a JSON object containing information about each QUIC stream of a Hysteria TCP proxy connection.

Response:

{
  "streams": [
    {
      "state": "estab", 
      "auth": "user", 
      "connection": 3191736581, 
      "stream": 4, 
      "req_addr": "192.0.2.1:80", 
      "hooked_req_addr": "example.com:80", 
      "tx": 3937, 
      "rx": 4441, 
      "initial_at": "2024-11-08T16:07:45.956956773+09:00", 
      "last_active_at": "2024-11-08T16:07:47.121503203+09:00" 
    }
  ]
}

When making a request to this API, you can add Accept: text/plain to the header to get a human-readable output similar to ss -atn.

Response:

State    Auth           Connection   Stream     TX-Bytes     RX-Bytes     Lifetime  Last-Active Req-Addr         Hooked-Req-Addr
ESTAB    user             BE3E0905        4         3937         4441       3.005s        1.84s 192.0.2.1:80     example.com:80