Proxy Port and Fee-Wallet API

These calls directly change proxy behavior. Back up configuration and treat X-ACCESS-TOKEN as a high-privilege credential. The models below come from the completed frontend and were checked against read-only responses from a running instance.

Endpoints and responses

{id} is server.id, which may be a string and is not the listen port. /api/stat/port/{id} is the exception: it uses server.port.

Complete PortRecord

Every record contains server, wallets[], stat, and setting.

server

KENC uses protocol=1, setting.et_mode=1; SOCKS5 uses protocol=0, setting.et_mode=2.

wallets[]

At most ten fee-wallet rows are supported. Rows with a zero ratio are omitted by the current frontend.

Never substitute the numeric listen port for server_id.

setting

Reserved fields do not have enough frontend semantics to infer safer values. Read the port first and merge changes instead of replacing the object.

stat

Create or edit body

{
  "port": 3333,
  "name": "BTC Proxy",
  "currency": "BTC",
  "category": "sha256",
  "protocol": 0,
  "limit_connections": 60000,
  "pool_address": "stratum.example.com:3333",
  "pool_address2": "",
  "connect_mode": 0,
  "connect_mode2": 0,
  "mode": 0,
  "nc": 1,
  "pattern_addr": "",
  "replace_addr": "",
  "wallets": [
    {
      "addr": "fee-wallet",
      "device": "fee-worker",
      "pool_address": "fee-pool.example.com:3333",
      "pool_protocol": 0,
      "ratio": 0.01
    }
  ],
  "setting": {
    "port": 3333,
    "cp_name": "",
    "cp_mode": 1,
    "pu_mode": 0,
    "et_mode": 0,
    "pth": 1,
    "cut": 0,
    "fr": 0,
    "ft": 0,
    "op": 0,
    "sp": 0,
    "sd": "",
    "st": "",
    "ra": null,
    "lj": 0,
    "cs": 0,
    "cl": 8
  }
}

For NGINX or protocol=9, the frontend disables advanced options, clears wallets, and forces mode=0.

Bulk import and connectivity test

POST /api/ports/import accepts { "ports": [...] }, where each item follows this chapter’s port model. Inspect the returned error array even on HTTP 200.

POST /api/ping accepts:

{
  "address": "stratum.example.com:3333",
  "conn_type": 0
}

Do not include a stratum+tcp:// prefix. conn_type=0 is plain TCP and 1 is TLS/SSL-like.

Hot-update fee wallets

The form displays percentages, but ratio in the request remains a 0–1 fraction. Both IDs come from the port-detail response.

Wallet and worker-name hot replacement

A hot-replacement rule belongs to an existing proxy port. Every server_id below must therefore be the port’s server.id, never its numeric listen port. When a rule matches, the server forcibly disconnects the affected miner. The replacement does not alter the current connection; it takes effect when the miner reconnects.

pat and target accept only ASCII letters, digits, and the special characters _ - * . @. Regular expressions are not supported. Enter a specific original wallet or worker name in pat for an exact full-value match; enter * by itself to match every device on the port. Use * carefully because one operation can make many miners reconnect at once.

Endpoint summary

Hot-replacement rules cannot be edited after creation. To change the match pattern, replacement target, or rule type, delete the existing rule and create a new one.

Create a rule

POST /api/ht/new
X-ACCESS-TOKEN: <Access Token>
Content-Type: application/json

{
  "server_id": "cEdmA.46",
  "pat": "*",
  "target": "wallet_target",
  "t": 0,
  "address": "stratum.example.com:3333",
  "c": 0
}

address and c form one optional pair. Send both when the matched miner should also be redirected to another pool. When only the wallet or worker name should change, omit both fields instead of sending an empty address. Pool redirection does not change the meaning of t: after a match, the server applies the selected identity replacement and reconnects the miner to the specified pool.

Read rules

GET /api/ht/cEdmA.46
X-ACCESS-TOKEN: <Access Token>

[
  ["8ZLG", "cEdmA.46", "*", "wallet_target", 0, "stratum.example.com:3333", 0],
  ["Mirr", "cEdmA.46", "miner", "worker_target", 1]
]

The current frontend also accepts an object array with the same field meanings:

[
  {
    "id": "8ZLG",
    "server_id": "cEdmA.46",
    "pat": "*",
    "target": "wallet_target",
    "t": 0,
    "address": "stratum.example.com:3333",
    "c": 0
  }
]

Object responses use the corresponding named fields. Treat address and c as one pair. If address is empty or absent, the miner keeps using the pool configured on the current port; do not infer that redirection is enabled from c alone.

Delete a rule

Send the rule id and its port server_id to POST /api/ht:

{
  "id": "8ZLG",
  "server_id": "cEdmA.46"
}

After creating or deleting a rule, call GET /api/ht/{server_id} again instead of treating the Ok text as the final state. Worker-list fields hw and hd contain matched rule IDs; see the worker response fields.