Developers

HF Panel has one address for programs: https://api.yourdomain.com:2087/v1. Billing systems, your own scripts, the HF Server desktop app, payment providers, routers and the other servers of a cluster all talk to it. This section explains each way in, with working examples.

Note: the API's address is for programs only. If you open it in a web browser you get 403 Forbidden. Use curl or your own code.

What you can program

The token API at a glance

• One base address: https://api.yourdomain.com:2087/v1. The old address https://panel.yourdomain.com:8443/api/v1 keeps working and gives the same answers.
• Each request carries an API token that you make under Password & security. A token is either Read only or Read & change, and you can limit it to some IP addresses.
• A token acts as the person who made it. An administrator's token sees every hosting account, a reseller's token sees only that reseller's customers, and a customer's token sees only their own account.
• Every answer is JSON: {"ok": true, "data": …} or {"ok": false, "error": "…"}, with a matching HTTP status.

curl -s https://api.yourdomain.com:2087/v1/me \
     -H "Authorization: Bearer hf_xxx"

{
    "ok": true,
    "data": {
        "username": "admin",
        "email": "admin@yourdomain.com",
        "role": "admin",
        "two_factor": true,
        "token": {
            "name": "Billing system",
            "access": "write"
        }
    }
}

Where to start

1. Read the API overview: addresses, tokens, answers, status codes and limits.
2. Make a token under Password & security › API tokens.
3. Try GET /v1/me as shown above, then pick the endpoints you need from the API reference.

Related

• API overview
• API reference
• Billing integration