Configuring a Provisioning Server

Step-by-step guide to filling in the Admin → Servers → New Server form for each control panel supported by BilloraX.

Last updated : May 1, 2026

Common fields

Field	Required	Description
`Name`	Yes	Internal server label, e.g. VPS-FR-01
`Control Panel`	Yes	Module type used for provisioning
`Hostname`	Yes	FQDN or IP of the server, e.g. srv1.example.com
`IP Address`	No	Public IP — informational only
`Max Accounts`	No	Hosting limit on this server (blank = unlimited)
`API URL`	Varies	Full API URL (see per-panel below)
`API Username`	Varies	API login (see per-panel)
`API Password / Token`	Varies	API password or key (see per-panel)

None — manual provisioning

No API connection. Services remain in PENDING status until an admin activates them manually from Admin → Services.

Field	Value
`API URL`	(leave blank)
`API Username`	(leave blank)
`API Password`	(leave blank)

cPanel / WHM

Before adding the server, retrieve the WHM Remote Access Hash: WHM → Development → Remote Access Key. This hash (hundreds of characters) is different from the root password.

Field	Value
`API URL`	https://srv1.example.com:2087
`API Username`	root (or WHM admin account)
`API Password`	WHM Remote Access Hash (WHM → Development → Remote Access Key)

⚠️

Do not confuse the Remote Access Hash with the SSH password. The hash is a long alphanumeric string generated in the WHM interface.

cPanel / WHM — Product settings

These settings are configured at the product level (Admin → Services → [Product]), not on the server.

Setting	Required	Description
`cPanel Package`	Yes	Exact package name in WHM, case-sensitive (WHM → Packages → Add a Package)
`Max Email Accounts`	No	0 = unlimited
`Max Databases`	No	0 = unlimited
`Disk Quota (MB)`	No	0 = unlimited
`Bandwidth (MB/month)`	No	0 = unlimited

Plesk

Create an API key in Plesk before adding the server: Plesk → Tools & Settings → Plesk API Access.

Field	Value
`API URL`	https://srv1.example.com:8443
`API Username`	admin
`API Password`	Plesk admin password or secret API key

Plesk — Product settings

Setting	Required	Description
`Subscription Plan`	Yes	Exact plan name in Plesk (Plesk → Service Plans)
`Disk Quota (MB)`	No	0 = unlimited
`Bandwidth (MB/month)`	No	0 = unlimited
`Extra Domains`	No	0 = no aliases

DirectAdmin

Generate an API key in DirectAdmin: Admin Panel → Your Account → API Keys.

Field	Value
`API URL`	https://srv1.example.com:2222
`API Username`	admin
`API Password`	DirectAdmin API Key

DirectAdmin — Product settings

Setting	Required	Description
`DirectAdmin Package`	Yes	Package name (Admin Panel → Manage User Packages)

HestiaCP

Create an API access key in HestiaCP: Admin → Access Keys → Add Key.

Field	Value
`API URL`	https://srv1.example.com:8083
`API Username`	admin
`API Password`	HestiaCP Access Key

HestiaCP — Product settings

Setting	Required	Description
`HestiaCP Package`	Yes	Package name (Packages → WEB)

Virtualizor

Generate API credentials in Virtualizor: Virtualizor Admin → Configuration → API.

Field	Value
`API URL`	https://srv1.example.com:4085
`API Username`	API Key (APIKEY)
`API Password`	API Secret (APISECRET)

Virtualizor — Product settings

Setting	Required	Description
`Plan ID`	Yes	Numeric plan ID (Plans → VPS Plans)
`RAM (MB)`	Yes	e.g. 1024 for 1 GB
`Disk (GB)`	Yes	Primary disk size
`vCPU`	Yes	Number of virtual cores
`Bandwidth (GB/mo)`	No	0 = unlimited
`Default OS ID`	No	OS ID from Virtualizor → OS Templates

Pterodactyl

Create an Application API Key in the Pterodactyl panel: Admin → API → Create New API Key. Check all permissions under the Application API tab.

Field	Value
`API URL`	Full panel URL, e.g. https://panel.example.com
`API Username`	(leave blank — not used)
`API Password`	Application API Key (starts with ptla_)

⚠️

Use the Application API, not the Client API. The Client API (found in user accounts) cannot create servers programmatically.

Pterodactyl — Product settings

Setting	Required	Where to find it
`Node ID`	Yes	Admin → Nodes → click the node → check the URL (/admin/nodes/view/1)
`Nest ID`	Yes	Admin → Nests → check the URL (/admin/nests/1)
`Egg ID`	Yes	Admin → Nests → [Nest] → click the egg → URL (/admin/eggs/15/view)
`RAM (MB)`	Yes	0 = unlimited — e.g. 1024 = 1 GB
`Disk (MB)`	Yes	0 = unlimited — e.g. 5120 = 5 GB
`CPU (%)`	Yes	100 = 1 core, 200 = 2 cores, 0 = unlimited
`Swap (MB)`	No	0 = disabled, -1 = unlimited
`Max Databases`	No	0 = none
`Max Backups`	No	0 = none
`Extra Allocations`	No	Additional ports beyond the primary one
`Environment Variables`	No	JSON — e.g. {"SERVER_JARFILE":"server.jar","MINECRAFT_VERSION":"latest"}
`Startup Command`	No	Leave blank to use the egg's default
`Docker Image`	No	Leave blank to use the egg's default

✅

The node must have at least one free allocation (unassigned IP + port) before a server can be created. Add allocations: Admin → Nodes → [Node] → Allocation.

Pterodactyl — Automatic delivery

When a client places an order, BilloraX automatically creates (or finds) a Pterodactyl account using the client's email, finds a free allocation on the configured node, fetches the egg's default values, then creates the server via the API.

The Pterodactyl server ID is stored in the service's username field. The panel URL is saved in the service notes and displayed in the client portal. The client logs into the panel with their email address and the password generated at checkout.

Custom (CUSTOM)

Reserved for custom-developed modules. See the Creating a Module page to add your own control panel integration.

Testing the connection

After creating or editing a server, use the Test Connection button in Admin → Servers → [Server] → Edit to verify that BilloraX can reach the API with the configured credentials.