curl "https://your-paneldns-domain.com/api/v1/summary" \
-H "Authorization: Bearer YOUR_TOKEN"
{
"ok": true,
"data": {
"org": {
"id": 42,
"name": "Acme DNS",
"slug": "acme",
"status": "active",
"suspended_at": null
},
"plan": {
"id": 2,
"name": "Business",
"zones": 100,
"clients": 50,
"seats": 5,
"api_calls": null
},
"usage": {
"active_zones": 47,
"sub_clients": 12,
"api_calls_current_period": 1843
},
"links": {
"portal": "https://your-paneldns-domain.com/portal/acme",
"admin": "https://your-paneldns-domain.com/zones"
}
}
}
Org
Org Summary
Usage summary for your org. No specific scope required (any valid token).
GET
/
api
/
v1
/
summary
curl "https://your-paneldns-domain.com/api/v1/summary" \
-H "Authorization: Bearer YOUR_TOKEN"
{
"ok": true,
"data": {
"org": {
"id": 42,
"name": "Acme DNS",
"slug": "acme",
"status": "active",
"suspended_at": null
},
"plan": {
"id": 2,
"name": "Business",
"zones": 100,
"clients": 50,
"seats": 5,
"api_calls": null
},
"usage": {
"active_zones": 47,
"sub_clients": 12,
"api_calls_current_period": 1843
},
"links": {
"portal": "https://your-paneldns-domain.com/portal/acme",
"admin": "https://your-paneldns-domain.com/zones"
}
}
}
Returns your org’s current state — active zone count, sub-client count, plan limits, and current-billing-period API call usage. Designed to be polled once per page load (e.g. by a WHMCS service-detail page).
curl "https://your-paneldns-domain.com/api/v1/summary" \
-H "Authorization: Bearer YOUR_TOKEN"
{
"ok": true,
"data": {
"org": {
"id": 42,
"name": "Acme DNS",
"slug": "acme",
"status": "active",
"suspended_at": null
},
"plan": {
"id": 2,
"name": "Business",
"zones": 100,
"clients": 50,
"seats": 5,
"api_calls": null
},
"usage": {
"active_zones": 47,
"sub_clients": 12,
"api_calls_current_period": 1843
},
"links": {
"portal": "https://your-paneldns-domain.com/portal/acme",
"admin": "https://your-paneldns-domain.com/zones"
}
}
}