API Use Cases
Practical API use cases for hosting providers, agencies, resellers, automation engineers, and monitoring systems.
The API is useful when another system needs to read PanelConfig state or verify the result of an operational workflow. The current API is especially suitable for dashboards, provider portals, monitoring collectors, support tooling, billing reconciliation, security review panels, and deployment checks.
Recommended Use Cases
| Use case | Useful endpoints | Notes |
|---|---|---|
| Provider dashboard | /accounts.php, /domains.php, /server-health.php, /jobs.php | Good for status panels and internal NOC screens. |
| Customer portal summary | /websites.php, /email-accounts.php, /databases.php, /ssl-certificates.php | Use a customer-owned token only when account filtering is required. |
| Security review | /security-events.php, /ip-blocks.php, /malware-scans.php, /audit-logs.php | Some endpoints require an admin-capable user. |
| Backup visibility | /backups.php, /backup-schedules.php, /backup-restores.php | Useful for compliance reports and support checks. |
| Deployment validation | /websites.php, /php-runtime.php, /website-logs.php, /jobs.php | Use after deployment scripts to confirm the panel state. |
What Not to Use It for Yet
Do not use the current API documentation to imply that remote provisioning writes are live unless a matching endpoint file exists. In this source snapshot, the API exposes many read resources, while create/update/delete endpoints are better treated as integration-ready roadmap items.
Security Guidance
- Use separate tokens per integration.
- Prefer short expiry periods for CI/CD and support tooling.
- Store tokens in a secret manager, not in source code.
- Review API request logs during incident response.