Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/thenoname-gurl/EcliPanel/llms.txt

Use this file to discover all available pages before exploring further.

The EcliPanel backend exposes a REST API that the frontend, Wings nodes, and external integrations all use. Every resource in the panel — servers, organisations, nodes, tickets, billing, AI, tunnels — has a corresponding set of JSON endpoints. You can call the API directly with any HTTP client, automate workflows with API keys, or explore it interactively via the built-in OpenAPI playground.

​
Base URL

The backend listens on the port set in your backend/.env file. The Next.js frontend automatically proxies all /api/* requests to the backend, so from the browser you always hit the same origin. When calling the API directly — from a script or external service — use the backend’s address: 
https://<your-backend-host>/api
For the production EcliPanel instance hosted by EclipseSystems, the backend is available at: 
https://backend.ecli.app

​
OpenAPI playground

The backend serves an interactive OpenAPI playground at the /openapi route. You can use it to browse every available endpoint, inspect request schemas, and send test requests without writing any code. 
https://backend.ecli.app/openapi
If you are running EcliPanel yourself, replace the host with your own backend address. The playground is always available on a running backend.

​
Response format

All responses are JSON. Successful operations return the resource or a confirmation object. Errors always return a JSON body with an error key: 
{ "error": "message describing what went wrong" }

​
HTTP status codes

CodeMeaning
200Success
201Resource created
400Bad request — missing or invalid parameters
401Unauthorized — authentication required or token invalid
403Forbidden — authenticated but not permitted
429Too many requests — rate limit exceeded
503Feature disabled — endpoint is turned off by the panel operator

​
Feature-gated endpoints

Some endpoints are controlled by feature flags set in the backend configuration. If a feature is disabled, any request to an endpoint in that group returns 503: 
{ "error": "Feature 'billing' is disabled" }
The following feature flags gate their respective endpoint groups:
Feature flagAffected endpoints
ai/api/ai/*
ticketing/api/tickets/*, /api/admin/tickets/*
applications/api/applications/*, /api/public/applications/*
billing/api/orders/*, /api/plans/*, /api/billing/*
oauth/api/oauth/*
registration/api/users/register
dnsOrganisation DNS zone endpoints
tunnels/api/tunnel/*

​
Rate limiting

The API enforces per-IP and per-account rate limits on sensitive endpoints. When a limit is exceeded, the response is 429 with a Retry-After header indicating how many seconds to wait: 
{ "error": "rate_limited", "retryAfter": 30 }
Login, 2FA verification, and API key creation are among the endpoints with rate limits applied.

​
WebSocket support

The server console is available over WebSocket for real-time output streaming. Connect using the token obtained from the REST API: 
wss://<your-backend-host>/api/servers/:id/websocket
Send commands to the server and receive console output in real time. Authentication uses the same session token as REST requests.

​
Example request

curl -X GET https://backend.ecli.app/api/auth/session \
  -H "Authorization: Bearer <your-token>"

{
  "id": 42,
  "email": "user@example.com",
  "firstName": "Alex",
  "role": "user",
  "twoFactorEnabled": false,
  "emailVerified": true
}

​
Endpoint groups

Authentication

Log in, manage sessions, set up 2FA, and create API keys

Servers

Create, power, transfer, reinstall, and monitor game servers

Organisations

Manage multi-tenant workspaces, members, roles, and DNS zones

Nodes

Register nodes, view heartbeats, and manage allocations

Billing & orders

Create orders, manage plans, and retrieve invoices

AI endpoints

Chat completions, AI Studio, and model management

Tickets

Create and manage support tickets and replies

Admin

Panel-wide administration, user management, and audit logs

Build docs developers (and LLMs) love

Get started for freeTalk to us