API HiTechCloud

HiTechCloud cung cấp một REST API đầy đủ, phản chiếu mọi chức năng của giao diện web. Mọi tính năng có trong panel đều có thể truy cập bằng chương trình.

Cũng có sẵn một đặc tả OpenAPI 3.0 đọc được bằng máy, bao quát mọi endpoint bên dưới — hãy nhập vào Postman/Insomnia, sinh SDK máy khách, hoặc nạp vào Swagger UI/Redoc.

Xác thực​

Mọi yêu cầu, trừ endpoint đăng nhập, đều mang một Bearer token.

API là một tính năng Enterprise. Cả cờ tính năng chung api và cờ tính năng riêng của endpoint bạn gọi đều phải được gói hosting của tài khoản cấp.

POST /api/login​

Tuyến duy nhất nhận mật khẩu. Gửi JSON:

curl -s -X POST https://panel.example.com/api/login \
  -H "Content-Type: application/json" \
  -d '{"username": "stefan", "password": "yourpassword"}'

Khi thành công — 200:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user_id": 1,
  "expires_in": 3600
}

Token là một JWT HS256 có chủ thể là id người dùng dạng số, có hiệu lực một giờ (expires_in tính bằng giây). Không có refresh token; hãy đăng nhập lại.

Đăng nhập thành công là một lần đăng nhập thật: nó được ghi vào lịch sử đăng nhập và nhật ký hoạt động của tài khoản dưới dạng logged in via user API, và kích hoạt thông báo đăng nhập của tài khoản nếu tuỳ chọn đó đang bật.

Nếu tài khoản có xác thực hai yếu tố và không gửi twofa_code — 401:

{"twofa_required": true, "user_id": 1}

Hãy thử lại với twofa_code trong phần thân. Mã không hợp lệ trả về 401 kèm {"error": "invalid_2fa"}.

Thất bại. Thiếu username hoặc password trả về 400. Mọi trường hợp khác trả về 401 kèm một mã error ổn định, đọc được bằng máy:

token_generation_failed và internal_error trả về 500.

Giới hạn tần suất. Các lần đăng nhập được đếm theo IP máy khách trong một cửa sổ cố định một phút. Giới hạn là cài đặt login_ratelimit của panel, mặc định 5 lần mỗi phút. Vượt quá, yêu cầu không bao giờ tới bước kiểm tra mật khẩu và câu trả lời là 429:

{"error":"rate_limit_exceeded","message":"Too many requests. Please try again later."}

Mỗi lần bị chặn tần suất được ghi vào /var/log/hitechcloud/user/failed_login.log và tính vào IP đó. Khi bộ đếm vượt login_blocklimit (mặc định 20), IP bị cấm tạm thời một giờ trong ConfigServer Firewall, nếu đã cài CSF. Đăng nhập thành công sẽ xoá bộ đếm của IP. Các bộ đếm nằm trong tiến trình panel, nên khởi động lại panel sẽ xoá chúng.

POST /api/auth/ticket và POST /api/auth/ticket/redeem​

Vé đăng nhập dùng một lần cho phép một ứng dụng đã đăng nhập mở một ứng dụng HiTechCloud khác mà đã ở trạng thái đăng nhập. Lệnh gọi đầu nhận Bearer token của bạn và trả về một vé sống 30 giây (tối đa 60) và chỉ dùng được một lần; lệnh gọi thứ hai nhận vé mà không cần token, và trả lời giống POST /api/login. Toàn bộ hợp đồng nằm ở Vé đăng nhập ứng dụng.

Dùng token​

curl https://panel.example.com/api/account \
  -H "Authorization: Bearer eyJhbGciOi..."

MySQL​

Mọi endpoint MySQL đều phẳng — không có kiểu lồng /api/mysql/<db_name>/users. Cơ sở dữ liệu nằm dưới /api/mysql/databases, người dùng dưới /api/mysql/users, và hai thứ được gắn với nhau bằng một tài nguyên riêng /api/mysql/grants.

Liệt kê cơ sở dữ liệu​

GET /api/mysql/databases
Authorization: Bearer <token>

{
  "databases": [
    {"name": "mydb", "assigned_users": "myuser"}
  ],
  "total": 1
}

Tạo cơ sở dữ liệu​

POST /api/mysql/databases
Content-Type: application/json

{"name": "newdb"}

Xoá cơ sở dữ liệu​

DELETE /api/mysql/databases/newdb

Liệt kê các bảng trong một cơ sở dữ liệu​

GET /api/mysql/databases/mydb/tables

{
  "database": "mydb",
  "tables": [
    {"table": "wp_posts", "rows": 120, "data_length": 98304, "index_length": 32768, "data_free": 0}
  ]
}

Tối ưu / sửa chữa một cơ sở dữ liệu​

Chạy OPTIMIZE TABLE hoặc REPAIR TABLE trên mọi bảng trong cơ sở dữ liệu.

POST /api/mysql/databases/mydb/optimize
POST /api/mysql/databases/mydb/repair

{
  "database": "mydb",
  "action": "optimize",
  "results": [
    {"table": "wp_posts", "status": "ok", "details": [{"op": "optimize", "msg_type": "status", "msg_text": "OK"}]}
  ]
}

Xuất một cơ sở dữ liệu​

Truyền trực tiếp (stream) một tệp .sql hoặc .sql.gz để tải xuống.

GET /api/mysql/databases/mydb/export?format=sql

Nhập một cơ sở dữ liệu​

Tải lên dạng multipart — tên trường phải là file. Chấp nhận .sql hoặc .sql.gz.

POST /api/mysql/databases/mydb/import
Content-Type: multipart/form-data

file=@dump.sql

Lấy dung lượng đĩa của từng cơ sở dữ liệu​

Phản chiếu chế độ xem kích thước cơ sở dữ liệu của giao diện web — khác với /api/mysql/info, không có dữ liệu kích thước, và /api/mysql/databases/<db>/tables, tính theo từng bảng của một cơ sở dữ liệu.

GET /api/mysql/size?unit=mb&show_all=false

{"sizes": [{"database": "mydb", "size": 12.4}], "total": 1, "unit": "MB"}

Đặt mật khẩu root của MySQL​

Chỉ ghi — không thể lấy lại mật khẩu hiện tại. Cập nhật cả hai host % và localhost và khởi động lại dịch vụ.

PUT /api/mysql/root-password
Content-Type: application/json

{"password": "newRootPass123"}

Liệt kê người dùng cơ sở dữ liệu​

GET /api/mysql/users

{"users": ["myuser", "shopuser"], "total": 2}

Tạo người dùng cơ sở dữ liệu​

POST /api/mysql/users
Content-Type: application/json

{"username": "dbuser", "password": "securepass", "host": "%"}

host mặc định là % nếu bỏ qua.

Xoá người dùng cơ sở dữ liệu​

DELETE /api/mysql/users/dbuser?host=%

Đổi mật khẩu của người dùng cơ sở dữ liệu​

PATCH /api/mysql/users/dbuser/password
Content-Type: application/json

{"password": "newpass", "host": "%"}

Lấy quyền của một người dùng trên một cơ sở dữ liệu​

GET /api/mysql/users/dbuser/privileges/mydb?host=%

{"username": "dbuser", "host": "%", "database": "mydb", "privileges": ["ALL PRIVILEGES"]}

Cấp quyền​

POST /api/mysql/grants
Content-Type: application/json

{"username": "dbuser", "database": "mydb", "privileges": ["ALL PRIVILEGES"], "host": "%"}

Thu hồi quyền​

DELETE /api/mysql/grants
Content-Type: application/json

{"username": "dbuser", "database": "mydb", "host": "%"}

Lấy bản tóm tắt cơ sở dữ liệu/người dùng/phân quyền​

GET /api/mysql/info

{
  "databases": ["mydb", "shop"],
  "users": ["dbuser", "shopuser"],
  "assigned_databases": [{"database": "mydb", "users": "dbuser"}]
}

Hiện danh sách tiến trình đầy đủ​

GET /api/mysql/processlist

{
  "processlist": [
    {"id": 42, "user": "dbuser", "host": "localhost", "db": "mydb", "command": "Query", "time": 0, "state": "", "info": "SELECT 1"}
  ],
  "total": 1
}

Trạng thái truy cập từ xa​

GET /api/mysql/remote-access

{
  "enabled": false,
  "server_ip": "203.0.113.10",
  "port": "3306",
  "user_access": [{"username": "dbuser", "hosts": ["%"]}]
}

Bật / tắt truy cập từ xa​

POST /api/mysql/remote-access
Content-Type: application/json

{"action": "enable"}

Cấp một mục truy cập từ xa​

Tạo một user@host mới (sao chép các quyền từ một host sẵn có của người dùng đó, nếu có).

POST /api/mysql/remote-access/entries
Content-Type: application/json

{"username": "dbuser", "host": "1.2.3.4", "password": "securepass"}

Đổi host của một mục truy cập từ xa​

PATCH /api/mysql/remote-access/entries
Content-Type: application/json

{"username": "dbuser", "old_host": "1.2.3.4", "new_host": "5.6.7.8"}

Gỡ một mục truy cập từ xa​

DELETE /api/mysql/remote-access/entries
Content-Type: application/json

{"username": "dbuser", "host": "1.2.3.4"}

Lấy cấu hình máy chủ​

GET /api/mysql/configuration

{
  "configuration": {"max_connections": "150"},
  "available_keys": ["max_connections", "max_allowed_packet", "innodb_buffer_pool_size", "..."]
}

Cập nhật cấu hình máy chủ​

Chỉ các khoá có trong available_keys được chấp nhận. Khởi động lại MySQL/MariaDB.

PUT /api/mysql/configuration
Content-Type: application/json

{"max_connections": "200"}

{"updated": true, "restarted": true, "configuration": {"max_connections": "200"}}

PostgreSQL​

Cấu trúc phẳng giống MySQL: cơ sở dữ liệu, người dùng và phân quyền là các tài nguyên cấp cao nhất riêng biệt.

Liệt kê cơ sở dữ liệu​

GET /api/postgresql/databases

{
  "databases": [{"name": "pgdb", "assigned_users": "pguser"}],
  "total": 1
}

Tạo cơ sở dữ liệu​

POST /api/postgresql/databases
Content-Type: application/json

{"name": "pgdb"}

Xoá cơ sở dữ liệu​

DELETE /api/postgresql/databases/pgdb

Xuất một cơ sở dữ liệu​

Truyền trực tiếp một bản dump .sql.

GET /api/postgresql/databases/pgdb/export

Nhập một cơ sở dữ liệu​

Tải lên dạng multipart — tên trường phải là file.

POST /api/postgresql/databases/pgdb/import
Content-Type: multipart/form-data

file=@dump.sql

{"database": "pgdb", "file": "dump.sql", "imported": true}

Liệt kê người dùng​

GET /api/postgresql/users

{"users": ["pguser"], "total": 1}

Tạo người dùng​

POST /api/postgresql/users
Content-Type: application/json

{"username": "pguser", "password": "securepass"}

Xoá người dùng​

Thu hồi quyền truy cập khỏi mọi cơ sở dữ liệu trước khi xoá vai trò.

DELETE /api/postgresql/users/pguser

Đổi mật khẩu của người dùng​

PATCH /api/postgresql/users/pguser/password
Content-Type: application/json

{"password": "newpass"}

Cấp mọi quyền trên một cơ sở dữ liệu​

POST /api/postgresql/grants
Content-Type: application/json

{"username": "pguser", "database": "pgdb"}

Thu hồi quyền​

DELETE /api/postgresql/grants
Content-Type: application/json

{"username": "pguser", "database": "pgdb"}

Lấy bản tóm tắt cơ sở dữ liệu/người dùng/phân quyền​

GET /api/postgresql/info

Hiện các kết nối đang hoạt động​

GET /api/postgresql/processlist

{
  "processlist": [
    {"pid": 123, "user": "pguser", "application": "psql", "client_addr": "127.0.0.1",
     "state": "active", "wait_event_type": "", "wait_event": "", "query": "SELECT 1",
     "backend_type": "client backend", "duration": "0:00:00.001"}
  ],
  "total": 1
}

Trạng thái truy cập từ xa​

GET /api/postgresql/remote-access

{"enabled": false, "server_ip": "203.0.113.10", "port": "5432", "postgres_port": 5432}

Bật / tắt truy cập từ xa​

POST /api/postgresql/remote-access
Content-Type: application/json

{"action": "enable"}

Lấy / cập nhật cấu hình máy chủ​

Cùng dạng với cấu hình MySQL — khởi động lại PostgreSQL khi lưu.

GET /api/postgresql/configuration
PUT /api/postgresql/configuration
Content-Type: application/json

{"max_connections": "200"}

Tên miền​

Liệt kê mọi tên miền​

GET /api/domains

{
  "domains": [
    {
      "domain": "example.com", "docroot": "/var/www/html", "php_version": "8.2",
      "site_count": 1, "redirect_url": null, "ssl": true, "status": "active",
      "suspend_comment": null, "has_dns_zone": true
    }
  ],
  "total": 1
}

Thêm một tên miền​

docroot mặc định là /var/www/html/. Tên miền .onion còn yêu cầu hs_ed25519_public_key và hs_ed25519_secret_key.

POST /api/domains
Content-Type: application/json

{"domain": "newdomain.com"}

Gỡ một tên miền​

DELETE /api/domains/olddomain.com

Lấy trạng thái tên miền​

Trạng thái SSL / tạm ngưng / chuyển hướng trong một lệnh gọi.

GET /api/domains/example.com/status

{"domain": "example.com", "ssl": true, "status": "active", "suspend_comment": null, "redirect_url": null}

Tạm ngưng / bỏ tạm ngưng một tên miền​

POST /api/domains/example.com/suspend
POST /api/domains/example.com/unsuspend

Lấy / đổi thư mục gốc tài liệu​

docroot phải nằm trong /var/www/html/.

GET /api/domains/example.com/docroot

PUT /api/domains/example.com/docroot
Content-Type: application/json

{"docroot": "/var/www/html/example.com/public"}

Lấy / đặt / gỡ một chuyển hướng​

GET /api/domains/example.com/redirect

PUT /api/domains/example.com/redirect
Content-Type: application/json

{"redirect_url": "https://newsite.com"}

DELETE /api/domains/example.com/redirect

Lấy trạng thái SSL​

GET /api/domains/example.com/ssl

{"domain": "example.com", "ssl_mode": "auto", "keys": ""}

Cấp / gia hạn SSL​

action là bắt buộc — một trong autossl, generate, switch_and_generate hoặc custom (loại này còn yêu cầu public_path và private_path, cả hai nằm trong /var/www/html/).

POST /api/domains/example.com/ssl
Content-Type: application/json

{"action": "autossl"}

Chứng chỉ tuỳ chỉnh:

POST /api/domains/example.com/ssl
Content-Type: application/json

{
  "action": "custom",
  "public_path": "/var/www/html/certs/example.com.crt",
  "private_path": "/var/www/html/certs/example.com.key"
}

Lấy / lưu cấu hình VHost​

GET /api/domains/example.com/vhost

PUT /api/domains/example.com/vhost
Content-Type: application/json

{"vhost": "...vhost content..."}

Lấy / đặt ghi đè kiểu chữ hiển thị​

Chỉ mang tính hiển thị — ví dụ hiện "MyBrand.com" thay vì "mybrand.com" trên giao diện.

GET /api/domains/example.com/capitalize

{"domain": "example.com", "capitalized_domain": "example.com"}

PUT /api/domains/example.com/capitalize
Content-Type: application/json

{"capitalized_domain": "Example.com"}

Lấy giá trị băm của bản ghi TLSA​

Dành cho các bản ghi DNS DANE/TLSA, được tính từ chứng chỉ SSL đang dùng của tên miền (Let's Encrypt hoặc tuỳ chỉnh).

GET /api/domains/example.com/tlsa-hash

{"hash_311": "a30dc1ad...", "hash_301": "05754994...", "cert_path": "/etc/hitechcloud/caddy/ssl/.../example.com.crt", "type": "letsencrypt"}

Vùng DNS (lồng dưới tên miền)​

Phần này phản chiếu Trình sửa vùng DNS độc lập bên dưới nhưng nằm dưới /api/domains/<domain>/.... Lưu ý khác biệt về tên trường: ở đây việc tạo bản ghi dùng value, còn các endpoint /api/dns độc lập dùng record.

GET /api/domains/example.com/dns

{
  "domain": "example.com",
  "serial": "2025011501",
  "records": [
    {"line_number": 12, "end_line_number": 12, "record": "www 3600 IN A 1.2.3.4"}
  ]
}

Lưu cả tệp vùng cùng một lúc:

PUT /api/domains/example.com/dns
Content-Type: application/json

{"zone_content": "$ORIGIN example.com.\n..."}

Thêm một bản ghi:

POST /api/domains/example.com/dns/records
Content-Type: application/json

{"name": "www", "ttl": "3600", "type": "A", "value": "1.2.3.4"}

Cập nhật / xoá một bản ghi theo số dòng (end_row_id bao quát các bản ghi nhiều dòng như DKIM):

PUT /api/domains/example.com/dns/records/12
Content-Type: application/json

{"content": "www 3600 IN A 5.6.7.8", "end_row_id": 12, "serial": "2025011501"}

DELETE /api/domains/example.com/dns/records/12
Content-Type: application/json

{"end_row_id": 12}

Đặt lại vùng về mẫu mặc định, hoặc xuất ra thành tệp:

POST /api/domains/example.com/dns/restart
GET /api/domains/example.com/dns/export

Nhật ký truy cập​

GET /api/domains/example.com/logs?page=1&show_all=false

{
  "domain": "example.com",
  "logs": [{"ts": "2025-01-15T12:00:00Z", "status": 200, "path": "/"}],
  "total": 1,
  "page": 1,
  "total_pages": 1,
  "items_per_page": 1000
}

Email​

Liệt kê hộp thư​

GET /api/emails

{
  "emails": [
    {"address": "info@example.com", "quota_limit": "1024", "quota_used": "12"}
  ]
}

Tạo hộp thư​

domain, username và password đều bắt buộc. gb + format tuỳ chọn đặt hạn mức riêng.

POST /api/emails
Content-Type: application/json

{"domain": "example.com", "username": "info", "password": "mailpass123"}

Lấy chi tiết hộp thư​

GET /api/emails/info@example.com

{
  "address": "info@example.com",
  "quota_limit": "1024",
  "quota_used": "12",
  "incoming": "ACCEPT",
  "outgoing": "ACCEPT",
  "server_ip": "203.0.113.10",
  "mail_host": "mail.example.com"
}

Cập nhật hộp thư​

Cần ít nhất một trong: gb+format, incoming (suspend/allow), outgoing (suspend/allow) hoặc password.

PATCH /api/emails/info@example.com
Content-Type: application/json

{"password": "newpass456"}

Xoá hộp thư​

DELETE /api/emails/info@example.com

Mở một hộp thư trong ứng dụng Mail​

POST /api/emails/mail-ticket/user@example.com

Cấp một vé đăng nhập dùng một lần (30 giây, chỉ dùng một lần) cho một trong các hộp thư của bạn, dành cho hành động "Open in Mail" của các ứng dụng panel. Không có phần thân.

{
  "ticket": "v1.dXNlckBleGFtcGxlLmNvbQ.1760000030000.nonce.hexsig",
  "expires_at": 1760000030,
  "expires_in": 30,
  "server": "mail.example.com",
  "url": "hitechcloud-mail://open?server=mail.example.com&ticket=v1....&user=user%40example.com"
}

Toàn bộ hợp đồng nằm ở Mở một hộp thư trong ứng dụng Mail.

Tải cấu hình ứng dụng thư​

config_type là một trong thunderbird, outlook, apple.

GET /api/emails/configuration/thunderbird/info@example.com?ssl=true

Liệt kê bí danh​

GET /api/emails/aliases

{
  "aliases": [
    {"source": "alias@example.com", "targets": ["real@example.com"]}
  ]
}

Tạo bí danh​

POST /api/emails/aliases
Content-Type: application/json

{"username": "alias", "domain": "example.com", "target": "real@example.com"}

Lấy các đích của một bí danh​

GET /api/emails/aliases/alias@example.com

{"source": "alias@example.com", "targets": ["real@example.com"]}

Thêm một đích vào bí danh sẵn có​

POST /api/emails/aliases/alias@example.com
Content-Type: application/json

{"target": "second@example.com"}

Xoá một đích của bí danh (hoặc cả bí danh)​

DELETE /api/emails/aliases/alias@example.com
Content-Type: application/json

{"target": "real@example.com"}

Xoá mọi đích của bí danh:

DELETE /api/emails/aliases/alias@example.com
Content-Type: application/json

{"delete_all": true}

Lấy địa chỉ catch-all​

GET /api/emails/default/example.com

{"domain": "example.com", "destination": null}

Đặt / gỡ địa chỉ catch-all​

Bỏ qua hoặc để trống destination để gỡ nó.

PUT /api/emails/default/example.com
Content-Type: application/json

{"destination": "catchall@example.com"}

Kiểm tra khả năng gửi thư (mọi tên miền)​

GET /api/emails/deliverability

Kiểm tra khả năng gửi thư của một tên miền​

So sánh DNS thực tế với những gì máy chủ thư mong đợi cho DKIM, SPF và DMARC.

GET /api/emails/deliverability/example.com

{
  "domain": "example.com",
  "server_ip": "203.0.113.10",
  "ok": true,
  "dkim": {"status": "ok", "current": "v=DKIM1; ...", "expected": "v=DKIM1; ..."},
  "spf": {"status": "ok", "current": "v=spf1 ip4:203.0.113.10 ~all", "expected": "v=spf1 ip4:203.0.113.10 ~all"},
  "dmarc": {"status": "ok", "current": "v=DMARC1; p=none", "expected": "v=DMARC1; p=none"}
}

Lấy bộ lọc thư Sieve​

GET /api/emails/filters/user@example.com

{
  "email": "user@example.com",
  "raw": "require [\"fileinto\"];\nif header :contains \"Subject\" \"SPAM\" { fileinto \"Junk\"; }",
  "parsed": [{"condition": "header :contains \"Subject\" \"SPAM\"", "action": "fileinto \"Junk\""}]
}

Cập nhật bộ lọc Sieve​

PUT /api/emails/filters/user@example.com
Content-Type: application/json

{"content": "require [\"fileinto\"];\nif header :contains \"Subject\" \"SPAM\" { fileinto \"Junk\"; }"}

Xuất hộp thư​

Trả về một tệp CSV để tải xuống (email,password,quota — mật khẩu luôn để trống, vì nó không bao giờ được lưu ở dạng có thể đảo ngược).

GET /api/emails/export

Nhập hộp thư​

Hai bước: lệnh gọi đầu kiểm tra tệp CSV tải lên và trả về một import_token; lệnh gọi thứ hai xác nhận và tạo các hộp thư.

POST /api/emails/import
Content-Type: multipart/form-data

file=@mailboxes.csv

{"import_token": "...", "valid_users": [{"email": "info@example.com", "..."}], "invalid_users": []}

POST /api/emails/import/confirm
Content-Type: application/json

{"import_token": "..."}

{"message": "...", "created": 3, "results": [{"email": "info@example.com", "status": "created"}]}

FTP​

Liệt kê tài khoản FTP​

GET /api/ftp

{
  "accounts": [{"username": "ftpuser@example.com", "path": "/var/www/html", "uid": "1000", "gid": "1000"}],
  "server_ip": "203.0.113.10",
  "ftp_host": "203.0.113.10"
}

Tạo tài khoản FTP​

domain là bắt buộc — tài khoản được tạo dưới dạng username@domain, và path phải bắt đầu bằng /var/www/html/.

POST /api/ftp
Content-Type: application/json

{"username": "ftpuser", "password": "ftppass", "domain": "example.com", "path": "/var/www/html/"}

Xoá tài khoản FTP​

DELETE /api/ftp/ftpuser@example.com

Đổi mật khẩu FTP​

PATCH /api/ftp/ftpuser@example.com/password
Content-Type: application/json

{"password": "newftppass"}

Đổi thư mục chính của FTP​

PATCH /api/ftp/ftpuser@example.com/path
Content-Type: application/json

{"path": "/var/www/html/subdir"}

Liệt kê các kết nối FTP đang hoạt động​

GET /api/ftp/connections

Tải cấu hình ứng dụng FTP​

config_type là một trong cyberduck, filezilla.

GET /api/ftp/configuration/filezilla/ftpuser@example.com

Cron Job​

Liệt kê mọi cron job​

GET /api/crons

{
  "jobs": [
    {"comment": "my job", "schedule": "0 * * * *", "container": "php-fpm-8.1", "command": "/usr/bin/php /var/www/html/cron.php"}
  ],
  "containers": ["php-fpm-8.1", "nginx"],
  "schedule_issues": []
}

Tạo một cron job​

schedule, command và container là bắt buộc. comment mặc định là tên container.

POST /api/crons
Content-Type: application/json

{"schedule": "*/5 * * * *", "command": "/usr/bin/php /var/www/html/run.php", "container": "php-fpm-8.1", "comment": "my job"}

Sửa một cron job​

Job được xác định bằng cách so khớp chính xác original_schedule, original_command, original_container và original_comment với mục hiện có.

PATCH /api/crons
Content-Type: application/json

{
  "original_schedule": "*/5 * * * *",
  "original_command": "/usr/bin/php /var/www/html/run.php",
  "original_container": "php-fpm-8.1",
  "original_comment": "my job",
  "schedule": "0 */2 * * *",
  "command": "/usr/bin/php /var/www/html/run.php",
  "container": "php-fpm-8.1",
  "comment": "my job"
}

Xoá một cron job​

schedule, command, container và comment đều phải khớp chính xác với job hiện có.

DELETE /api/crons
Content-Type: application/json

{"schedule": "*/5 * * * *", "command": "/usr/bin/php /var/www/html/run.php", "container": "php-fpm-8.1", "comment": "my job"}

Lấy / lưu crontab thô​

GET /api/crons/raw

PUT /api/crons/raw
Content-Type: application/json

{"content": "0 * * * * /usr/bin/php /var/www/html/cron.php\n"}

Theo dõi nhật ký cron​

GET /api/crons/log?lines=50&job=cron.php

Dịch vụ bộ nhớ đệm​

Redis, Valkey, Memcached, Elasticsearch và OpenSearch đều theo cùng một mẫu hai endpoint: một GET trạng thái và một POST hành động nhận {"action": "enable" | "disable" | "restart"}.

Redis / Valkey / Memcached / Elasticsearch / OpenSearch​

GET  /api/cache/redis
POST /api/cache/redis
Content-Type: application/json

{"action": "enable"}

{
  "service": "redis", "port": 6379,
  "description": "In-memory key-value store used primarily as an application cache.",
  "container_state": "running", "health_status": "healthy",
  "actions": ["disable"]
}

Các dịch vụ còn lại theo cùng mẫu, chỉ cần thay redis bằng tên dịch vụ:

GET  /api/cache/valkey
POST /api/cache/valkey        {"action": "disable"}

GET  /api/cache/memcached
POST /api/cache/memcached     {"action": "restart"}

GET  /api/cache/elasticsearch
POST /api/cache/elasticsearch {"action": "enable"}

GET  /api/cache/opensearch
POST /api/cache/opensearch    {"action": "enable"}

Varnish​

Varnish có thêm thống kê và công tắc theo từng tên miền, bên cạnh cặp trạng thái/hành động chuẩn.

# Status + domain list
GET /api/cache/varnish

{
  "service": "varnish", "container_state": "stopped", "health_status": "unknown",
  "actions": ["enable", "restart"],
  "domain_statuses": {"example.com": "Off"}
}

# Enable/disable/restart
POST /api/cache/varnish
Content-Type: application/json

{"action": "enable"}

# Hit ratio and traffic stats
GET /api/cache/varnish/stats

# Per-domain Varnish status
GET /api/cache/varnish/domains

# Toggle Varnish for a specific domain
POST /api/cache/varnish/domains/example.com
Content-Type: application/json

{"status": "On"}

{
  "status": "running",
  "cache": {"hit_ratio": 0.92, "hits": 9200, "misses": 800, "pass": 0},
  "traffic": {"requests_total": 10000, "connections": 500},
  "backend": {"requests": 800, "failures": 0, "retries": 0, "health": "healthy"},
  "memory": {"objects": 120, "evictions": 0},
  "performance": {"efficiency_score": 92, "error_rate": 0.0}
}

Docker / Container​

Liệt kê các dịch vụ compose​

GET /api/containers

Liệt kê các container đang chạy​

GET /api/containers/status

{"running_containers": ["nginx", "mysql", "php-fpm-8.2"]}

Lấy trạng thái của một container​

GET /api/containers/nginx/status

{"service": "nginx", "state": "running", "health": "healthy"}

Khởi động / dừng / khởi động lại​

POST /api/containers/nginx/start
POST /api/containers/nginx/stop
POST /api/containers/nginx/restart

Khởi động và kéo image về trước:

POST /api/containers/nginx/start
Content-Type: application/json

{"pull": true}

Cập nhật giới hạn CPU/RAM/PID​

PATCH /api/containers/myapp/resources
Content-Type: application/json

{"cpu": "1", "ram": "512m", "pids": "512"}

Cả ba trường đều tuỳ chọn — chỉ gửi những trường bạn muốn đổi.

{"message": "Resources updated", "results": {"cpu": "...", "ram": "...", "pids": "Max PIDs for container myapp set to 512"}}

Theo dõi nhật ký container​

GET /api/containers/nginx/logs?lines=200

{"service": "nginx", "lines": 200, "entries": [{"log": "2025/01/15 12:00:00 [notice] start worker process"}]}

Thêm / sửa / gỡ một dịch vụ compose​

Đừng nhầm với PATCH /api/containers/<service>/resources (giới hạn CPU/RAM của một dịch vụ đã có, đã nêu ở trên) — các endpoint này quản lý sự hiện diện và định nghĩa của dịch vụ trong chính docker-compose.yml. volumes là một danh sách các {"name": "...", "mount": "...", "readonly": false}.

POST /api/containers
Content-Type: application/json

{
  "service_name": "phpmyadmin",
  "image": "phpmyadmin:latest",
  "cpu": "1",
  "ram": "512m",
  "network": "db",
  "environment": "PMA_HOST=mariadb",
  "add_socket": false,
  "volumes": []
}

PATCH /api/containers/myservice
Content-Type: application/json

{"cpu": "1", "ram": "512m", "environment": "..."}

DELETE /api/containers/myservice

Chuyển biến thể MySQL/MariaDB​

Xoá volume dữ liệu cũ.

POST /api/containers/mysql
Content-Type: application/json

{"new_sql": "mysql:8.0"}

Chuyển máy chủ web đang dùng​

POST /api/containers/webserver
Content-Type: application/json

{"new_ws": "nginx"}

Đổi image của một dịch vụ​

PATCH /api/containers/myservice/image
Content-Type: application/json

{"new_tag": "myimage:tag"}

WAF (Tường lửa ứng dụng web)​

Trạng thái của mọi tên miền​

GET /api/waf

{"domains": {"example.com": "On"}}

Trạng thái của một tên miền​

GET /api/waf/example.com

{"domain": "example.com", "status": "On", "removed_rules": [], "removed_tags": []}

Bật/tắt WAF​

POST /api/waf/example.com
Content-Type: application/json

{"status": "On"}

Cập nhật các quy tắc loại trừ​

Các trường trong phần thân là removed_rules (ID quy tắc dạng số) và removed_tags — không phải remove_by_id/remove_by_tag.

PUT /api/waf/example.com/rules
Content-Type: application/json

{
  "removed_rules": ["920170", "941100"],
  "removed_tags": ["attack-sqli"]
}

Nhật ký WAF có phân trang​

GET /api/waf/log/example.com?page=1&per_page=25

Thống kê WAF​

GET /api/waf/stats/example.com?seconds=3600

{"domain": "example.com", "seconds": 3600, "checks": 120, "blocks": 4}

Liệt kê ID / thẻ của quy tắc​

Cả hai lệnh gọi đều dùng cùng một tuyến có tham số, /api/waf/ids/<id_type>, chỉ chấp nhận ids hoặc tags làm đoạn đường dẫn:

GET /api/waf/ids/ids
GET /api/waf/ids/tags

{"ids": ["920170", "941100"]}

Chặn IP​

Liệt kê các IP bị chặn​

GET /api/ip-blocker

{"blocked_ips": ["1.2.3.4", "10.0.0.0/8"]}

Chặn IP​

Chấp nhận IP đơn lẻ và dải CIDR.

POST /api/ip-blocker
Content-Type: application/json

{"ips": ["1.2.3.4", "10.0.0.0/8"]}

{"blocked": ["1.2.3.4", "10.0.0.0/8"], "invalid": [], "message": "2 IP(s) added to blocklist"}

Bỏ chặn mọi IP​

DELETE /api/ip-blocker

PHP​

Liệt kê các phiên bản PHP đã cài​

GET /api/php/versions

Lấy nội dung php.ini​

GET /api/php/8.2/ini

Lưu php.ini​

PUT /api/php/8.2/ini
Content-Type: application/json

{"content": "memory_limit = 256M\nupload_max_filesize = 64M\n..."}

Lấy các khoá và giá trị tuỳ chọn PHP​

GET /api/php/8.2/options

Cập nhật một số tuỳ chọn PHP​

PUT /api/php/8.2/options
Content-Type: application/json

{"memory_limit": "256M", "upload_max_filesize": "64M", "max_execution_time": "300"}

Liệt kê các phần mở rộng kèm trạng thái​

GET /api/php/8.2/extensions

{
  "version": "8.2",
  "service": "php-fpm-8.2",
  "extensions": [
    {"name": "imagick", "state": "active"},
    {"name": "redis", "state": "disabled"},
    {"name": "swoole", "state": "not_installed"}
  ],
  "history": []
}

Bật/tắt một phần mở rộng​

enable là một giá trị boolean, không phải chuỗi action. PHP-FPM được khởi động lại sau đó.

POST /api/php/8.2/extensions
Content-Type: application/json

{"extension": "imagick", "enable": true}

Liệt kê mọi phần mở rộng được hỗ trợ​

GET /api/php/8.2/extensions/available

Cài phần mở rộng​

extensions là một danh sách (không phải một chuỗi extension đơn lẻ) — việc cài đặt chạy bất đồng bộ.

POST /api/php/8.2/extensions/install
Content-Type: application/json

{"extensions": ["swoole"]}

{"install_id": "b3f1...-uuid", "extensions": ["swoole"], "message": "Install started"}

Hỏi trạng thái cài đặt​

GET /api/php/8.2/extensions/install/status?install_id=b3f1...-uuid

Lấy / đặt phiên bản PHP mặc định của cả máy chủ​

Dùng cho các website/tên miền mới không có ghi đè riêng. Không dùng được theo cùng cách trên LiteSpeed — xem ghi chú theo từng tên miền bên dưới.

GET /api/php/default

{"version": "7.1", "service": "php-fpm-7.1", "is_litespeed": false, "installed_versions": ["8.5", "8.4", "..."]}

PUT /api/php/default
Content-Type: application/json

{"version": "8.2"}

Liệt kê / đổi phiên bản PHP gán cho từng tên miền​

PUT nhận tên miền trong phần thân yêu cầu, không phải trong đường dẫn URL. Không dùng được trên LiteSpeed vì nó không có PHP theo từng tên miền — hãy dùng PUT /api/php/default.

GET /api/php/domains

{
  "domains": [{"DomainID": 52, "DomainURL": "example.com", "PHPVersion": "8.5", "Level": "good"}],
  "counts": [{"Version": "8.5", "Count": 7, "Label": "Supported (Latest)", "Level": "good"}],
  "outdated_domains": [],
  "available_php_versions": ["8.5", "8.4", "..."],
  "php_default_version": "7.1",
  "is_litespeed": false
}

PUT /api/php/domains
Content-Type: application/json

{"domain": "example.com", "version": "8.2"}

Trình quản lý ứng dụng PHP​

Cài đặt và quản lý một dự án PHP dựa trên Composer trong thư mục gốc tài liệu của một tên miền sẵn có, chạy bên trong container php-fpm-<version> dùng chung mà phiên bản PHP của tên miền đó đã trỏ tới. Khác với trình cài ứng dụng Node.js/Python bên dưới, nó không bao giờ tạo container riêng — vhost sẵn có của tên miền đã định tuyến tới đúng container php-fpm.

Cài một ứng dụng PHP​

Phần thân dạng form-encoded; phản hồi truyền trực tiếp các sự kiện tiến trình JSON phân tách bằng dòng mới.

POST /api/php/install

Chạy lại composer install / update​

POST /api/php/apps/composer-install/example.com
POST /api/php/apps/composer-update/example.com
Content-Type: application/json

{"optimize_autoloader": "true"}

Lấy nhật ký chạy Composer​

GET /api/php/apps/logs/example.com

Phản hồi là văn bản thuần ("No Composer runs recorded yet." nếu chưa có lần chạy nào).

Gỡ một ứng dụng PHP​

Gỡ mục theo dõi của ứng dụng và các thiết lập .env — các tệp trong docroot và cơ sở dữ liệu, nếu có, được giữ nguyên.

DELETE /api/php/apps/example.com

Tài khoản​

Lấy thông tin tài khoản​

GET /api/account

{
  "username": "stefan",
  "email": "stefan@example.com",
  "plan_id": 1,
  "context": "stefan",
  "permit_username_change": false
}

Cập nhật tài khoản​

PATCH /api/account
Content-Type: application/json

{"email": "new@example.com"}
# or
{"password": "newpass"}
# or (only if allowed on this server)
{"username": "newname"}

Liệt kê các phiên đang hoạt động​

GET /api/account/sessions

Chấm dứt một phiên​

DELETE /api/account/sessions/<token>

Liệt kê / thêm / gỡ mục yêu thích​

GET /api/account/favorites

{"favorites": [{"link": "dashboard", "title": "Dashboard"}]}

POST /api/account/favorites
Content-Type: application/json

{"link": "dashboard", "title": "Dashboard"}

DELETE /api/account/favorites
Content-Type: application/json

{"link": "dashboard"}

Lấy / đặt ngôn ngữ giao diện ưa thích​

GET /api/account/language

{"locales": ["en", "de", "fr", "..."], "current": "en"}

PUT /api/account/language
Content-Type: application/json

{"locale": "de"}

Lấy lịch sử đăng nhập​

GET /api/account/login-history

{
  "entries": [
    {"ip": "203.0.113.10", "country_code": "US", "login_time": "2026-01-15 12:00:00"}
  ]
}

Lấy nhật ký hoạt động​

Có phân trang, mới nhất trước. search lọc theo chuỗi con (buộc show_all); show_all=true trả về mọi dòng khớp trên một trang.

GET /api/account/activity?page=1&search=&show_all=false

{
  "rows": [
    {"Timestamp": "2026-01-15 12:00:00", "IP": "203.0.113.10", "User": "myuser", "Action": "logged in via user API"}
  ],
  "page": 1, "per_page": 100, "total_pages": 3, "total_lines": 214,
  "show_all": false, "search": ""
}

Xác thực hai yếu tố​

Thiết lập gồm hai lệnh gọi: POST .../setup tạo một khoá bí mật đang chờ (2FA vẫn tắt), rồi POST .../confirm kiểm tra một mã với khoá đó và bật 2FA. Việc đăng ký passkey không có sẵn qua API — hãy dùng giao diện panel tại /account/passkeys để thêm. Việc liệt kê và thu hồi các passkey sẵn có được nêu bên dưới.

GET /api/account/2fa

{"enabled": false}

POST /api/account/2fa/setup

{"secret": "AHFB5DLV55SIZASCJEKFMSUPQ2GW6ZGV", "otpauth_url": "otpauth://totp/username?secret=...&issuer=HiTechCloud"}

POST /api/account/2fa/confirm
Content-Type: application/json

{"otp_code": "123456"}

DELETE /api/account/2fa

Liệt kê / thu hồi passkey​

GET /api/account/passkeys

{"passkeys": [{"id": 1, "name": "Passkey", "created_at": "2026-01-15 12:00:00", "last_used_at": ""}]}

DELETE /api/account/passkeys/1

Liệt kê / tạo / thu hồi token MCP​

Token gốc chỉ được trả về một lần, lúc tạo.

GET /api/account/mcp

{"tokens": [{"id": 1, "name": "my token", "token_prefix": "op_mcp_abc123", "read_only": true, "created_at": "2026-01-15 12:00:00"}]}

POST /api/account/mcp
Content-Type: application/json

{"name": "my token", "read_only": true, "expires_in_days": 30}

{"token": "op_mcp_...", "name": "my token", "read_only": true, "expires_in_days": 30}

DELETE /api/account/mcp/1

Lấy / cập nhật tuỳ chọn thông báo​

PUT chỉ đổi những khoá có trong phần thân — các khoá bạn bỏ qua được giữ nguyên.

GET /api/account/notifications

{"preferences": [{"key": "notify_account_login", "value": true, "label": " account login"}]}

PUT /api/account/notifications
Content-Type: application/json

{"preferences": {"notify_account_login": false}}

Mức sử dụng tài nguyên​

Ảnh chụp mới nhất​

GET /api/usage

{
  "cpu": {"usage": {"pct": 12.5}},
  "memory": {"usage_pct": 45, "used": {"human": "900MB"}, "total": {"human": "2GB"}},
  "bandwidth": {"usage_pct": 5, "limit": {"human": "100GB"}}
}

Lịch sử có phân trang​

GET /api/usage/history?page=1&per_page=25

Thông tin hosting​

Các endpoint thông tin chỉ đọc, luôn có sẵn. Chúng mô tả những gì một tài khoản cần để dùng hosting của mình - tên máy và IP để trỏ máy khách tới, bản phân phối và phiên bản phần mềm dùng chung mà mã của nó chạy trên đó, và các phiên bản PHP có thể gán cho một website. Trạng thái của chính máy (tải, uptime, kernel, CPU) thuộc về quản trị viên và không được báo cáo ở đây.

Thông tin hosting chung​

GET /api/hosting/info

{
  "node": "hitechcloud", "ip": "203.0.113.10", "os": "Ubuntu 24.04.3 LTS",
  "php_versions": ["8.4", "8.3", "8.2"],
  "software": [{"name": "Web Server", "version": "1.24.0"}, {"name": "Database", "version": "10.11.8"}]
}

Chi tiết gói hosting​

GET /api/hosting/plan

{
  "context": "myuser", "plan_webserver": "nginx", "plan_mysql": "mariadb",
  "plan_cpu_limit": "4", "plan_ram_limit": "6g", "plan_disk_limit": "50 GB",
  "plan_bandwidth": "500", "plan_domains_limit": "10", "plan_websites_limit": "10",
  "plan_db_limit": "20", "plan_email_limit": "500", "plan_ftp_limit": "100",
  "plan_inodes_limit": "1000000", "plan_max_email_quota": "2G",
  "plan_description": "A professional plan", "ns1": "", "ns2": "", "ns3": "", "ns4": ""
}

Các cổng truy cập từ xa được cấp​

GET /api/hosting/ports

{"remote_mysql_port": "32770", "remote_postgres_port": "32771"}