HF PanelDocsv1.0.0

API explorer

Every token API endpoint from the OpenAPI 3.1 description, grouped, with who may call it; and the description to download.

The token API is described in OpenAPI 3.1. Load the description into your API tool (Postman, Insomnia, Bruno) or a code generator to get every endpoint with its parameters, bodies and answers.

Where What
openapi.json the description, with example addresses (api.yourdomain.com)
GET https://api.yourdomain.com:2087/v1/openapi.json your server's own copy, with its addresses; no token needed
bash
curl -s https://api.yourdomain.com:2087/v1/openapi.json -o hf-panel-openapi.json

Tip: ready-made clients for Go, Python and TypeScript are on SDKs.

Endpoints

The table below is read from the description. Who: any token, staff (administrator and reseller tokens), admin (administrator tokens), account (a customer's own account, or any account staff manage); write needs a Read & change token.

Loading the endpoint list… If it does not appear, download openapi.json.