API Documentation

Integrate WisPanel with your applications using our comprehensive REST API.

API Reference

Base URL

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

All API endpoints are relative to this base URL.

Server Info

Server Info API

Get server status and information.

Get Server Status

GET /api/v1/server/status

Response

{
  "data": {
    "hostname": "server.example.com",
    "ip_address": "192.168.1.1",
    "os": "Ubuntu 22.04 LTS",
    "uptime": "15 days, 3 hours",
    "cpu_usage": 15.5,
    "memory_usage": 42.3,
    "disk_usage": 28.7,
    "wispanel_version": "1.0.0"
  }
}

Get System Services

GET /api/v1/server/services

Response

{
  "data": {
    "nginx": "running",
    "mysql": "running",
    "php-fpm": "running"
  }
}
Domains Error Handling

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