API reference
API reference
519 operations, generated from the panel's source.
Every screen of KyPanel uses this API, so anything the panel does can be scripted. Base URL https://YOUR-SERVER:7711; authentication, errors and jobs are explained in Using the API. The full description is also available as OpenAPI 3.1 (every server serves its own at /api/v1/openapi.json).
| Group | Operations | |
|---|---|---|
| API Tokens | 7 | Keys for scripts and billing systems: admin tokens (ACL areas, allowed IPs, expiry) and account tokens. |
| Accounts | 35 | Hosting accounts: create, suspend, terminate, change package, limits, owner, password; single sign-on links. |
| Apps | 46 | Git-deployed apps (PHP, Node.js, Python), releases, processes, environment, Redis, GitHub connections. |
| Authentication | 22 | Sign-in for Ky Admin and the customer panel, sessions, two-factor authentication. |
| Backups | 24 | Scheduled backups, destinations, restores and the customer's own backups. |
| Branding | 5 | Logo, colors and names shown on the panels, per server and per reseller. |
| Cloudflare | 10 | Cloudflare connection of an account: zones, record sync, proxy, cache purge. |
| Cron Jobs | 5 | Scheduled commands of an account. |
| DNS | 26 | DNS zones and records, zone templates. |
| Databases | 14 | MariaDB/MySQL databases, users, privileges, remote hosts, phpMyAdmin. |
| Domains | 18 | Main, addon, subdomain and alias domains; document roots, PHP version and settings, redirects, error pages. |
| 46 | Mailboxes, forwarders, autoresponders, filters, routing, spam, deliverability; the mail server and its queue. | |
| FTP | 7 | FTP accounts and sessions. |
| Files | 27 | File manager: list, read, write, upload, move, compress, trash, disk usage; protected folders. |
| IP Addresses | 7 | The server's IP addresses, shared and dedicated. |
| Import Tools | 15 | Account imports from backup files and transfers from remote servers. |
| Jobs | 3 | Background jobs: long operations answer 202 with a job_id. |
| License | 2 | The server's KyPanel license. |
| Logs | 5 | Error and access logs, visitors. |
| Mailbox (Mail tools) | 14 | Tools a mailbox owner uses from the webmail: password, filters, autoresponder, client settings. |
| Nodes | 7 | Email and database nodes paired with this server. |
| Notifications | 11 | Panel notifications and the contact channels (email, webhook) alerts go to. |
| PHP | 10 | Installed PHP versions, extensions and global settings. |
| Packages | 13 | Hosting packages and feature lists. |
| Resellers | 23 | Resellers, their limits, privileges and accounts. |
| SSH | 5 | SSH keys of an account. |
| SSL/TLS | 24 | Certificates, keys, CSRs and AutoSSL. |
| Security | 24 | Brute force protection, allow and block lists, firewall, security policies, hotlink protection. |
| Server | 41 | Server status, services, processes, settings, hostname, updates. |
| Terminal | 1 | Browser terminal (WebSocket). |
| Webhooks | 22 | Outgoing webhooks and the event feed. |