API Documentation

Integrate WisPanel with your applications using our comprehensive REST API.

Base URL

https://your-server-ip:2083/api/v1

All API endpoints are relative to this base URL.

Domains & Subdomains

API Domains & Subdomains

Quản lý domains, subdomains, cấu hình vhost, redirects và cài đặt domain.

Roles: Tất cả người dùng quản lý domains của mình. Admin xem tất cả.

Domains

Danh sách Domains

GET /api/v1/domains

Tạo Domain

POST /api/v1/domains
{
  "name": "example.com",
  "php_version": "8.2",
  "web_server": "nginx",
  "force_ssl": false,
  "www_redirect": "add_www"
}

Cập nhật Domain

PUT /api/v1/domains/{name}

Xóa Domain

DELETE /api/v1/domains/{name}

Subdomains

Danh sách Subdomains

GET /api/v1/domains/{domain}/subdomains

Tạo Subdomain

POST /api/v1/domains/{domain}/subdomains
{
  "subdomain": "api",
  "php_version": "8.2"
}

Pointers & Redirects

  • GET/POST/DELETE /api/v1/domains/{domain}/pointers - Quản lý domain aliases
  • GET/POST/PUT/DELETE /api/v1/domains/{domain}/redirects - Quản lý URL redirects

Bảo vệ thư mục

  • GET/POST/PUT/DELETE /api/v1/domains/{domain}/protected-dirs - Bảo vệ bằng mật khẩu

Rate Limiting

API requests are limited to 60 requests per minute per API token.

  • X-RateLimit-Limit: Maximum requests per minute
  • X-RateLimit-Remaining: Remaining requests
  • X-RateLimit-Reset: Unix timestamp when limit resets