API Overview
Everything in VirtlixCP, in the admin area and the client area, is done through its API. You can use the same API from your own tools and billing system.
API keys
For users: clients and admins create API keys on the API Keys page in the user menu at the top right of the panel. A key acts as the user who created it, with the same permissions.
For integrations: API keys are also used to connect integrations such as WHMCS. Go to System, Integrations, create an integration, select it, open API Keys and generate one. The integration uses this key whenever it talks to VirtlixCP, and you choose which permissions it has.
Making requests
The API lives on the api. name of your panel:
https://api.panel.example.com
Send the key as the key parameter, in the query string or in the request body, and ask for JSON:
curl -H 'Accept: application/json' 'https://api.panel.example.com/server?key=YOUR-API-KEY&per_page=20'
curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' \
-d '{"key": "YOUR-API-KEY", "hostname": "vps1.example.com"}' \
https://api.panel.example.com/pkg/vps/server/12/manage/hostname
Request bodies are JSON. Use GET to read, POST to create, PATCH to change and DELETE to remove.
Responses
Every response has the same shape:
{
"data": { ... },
"error": false,
"code": 200,
"messages": [{"type": "success", "text": "Server updated."}]
}
data holds the result. On an error, error is true, code is the HTTP status and messages explains what went wrong, for example a 422 with one message per invalid field.
Lists and paging
List endpoints return one page at a time inside data:
| Field | Meaning |
|---|---|
data |
The items on this page |
current_page, last_page |
Page numbers |
per_page |
Items per page, set with the per_page parameter |
total |
Number of matching items |
Ask for another page with page=2. Most lists also accept filters, listed with each endpoint.
Dates
Dates are returned as an object with iso_8601 (for example 2026-10-09T14:30:00+00:00) and unix (seconds since the Unix epoch).
Endpoint reference
The articles in this section list every endpoint, grouped by what it manages, with its parameters and response fields. The KVM VPS endpoints come from the VPS package included with VirtlixCP.