virtualizor-enduser-api

TypeScript/JavaScript client for the Virtualizor Enduser API.

The package is generated from the official Enduser API documentation and currently includes all documented callable Enduser API endpoints that expose an HTTP Request section in the docs. In the current docs snapshot used for this package, that is 89 callable endpoints across 26 documented groups.

Features

• Covers every documented callable Enduser API endpoint from the official docs snapshot.
• Generated endpoint registry with titles, parameter docs, request defaults, and doc URLs.
• Dynamic, typed client methods like listVps(), changeHostname(), createVm(), addDnsRecord(), createBackup(), and more.
• Every normal client call returns a consistent { success: true | false } result envelope.
• Generic callEndpoint() and request() helpers for future-proof usage.
• callEndpointRaw() and requestRaw() are available if you explicitly want throwing low-level behavior.
• Works in Node.js 18+ with the built-in fetch API.
• ESM and CommonJS builds.

Install

npm install virtualizor-enduser-api

Quick Start

import { VirtualizorEnduserClient } from 'virtualizor-enduser-api';

const client = new VirtualizorEnduserClient({
  baseUrl: 'https://your-virtualizor-host:4083',
  apiKey: 'your_api_key',
  apiPass: 'your_api_pass'
});

const vpsList = await client.listVps();
if (vpsList.success) {
  console.log(vpsList.data);
}

const vpsInfo = await client.vpsInfo({ svs: 1234 });
const hostnameChange = await client.changeHostname({ svs: 1234, newhost: 'vm01.example.test' });
console.log(hostnameChange.success);

Usage Patterns

Normal calls always return success

const result = await client.startVm({ svs: 1234 });

if (!result.success) {
  console.error(result.error);
  return;
}

console.log(result.data);

Call by slug

const result = await client.callEndpoint('change-hostname', {
  svs: 1234,
  newhost: 'vm01.example.test'
});

if (result.success) {
  console.log(result.data);
}

Inspect endpoint metadata

import { ENDUSER_ENDPOINTS } from 'virtualizor-enduser-api';

const endpoint = ENDUSER_ENDPOINTS.find((item) => item.slug === 'change-hostname');
console.log(endpoint?.docUrl);
console.log(endpoint?.parameters);

Raw requests

const result = await client.request({
  path: '/index.php',
  query: { act: 'listvs' }
});

Raw throwing behavior for advanced usage

const data = await client.callEndpointRaw('change-hostname', {
  svs: 1234,
  newhost: 'vm01.example.test'
});

const raw = await client.requestRaw({
  endpoint: 'list-vps'
});

Authentication

Virtualizor Enduser API requests are sent with these query parameters automatically:

• api=json
• apikey=<your api key>
• apipass=<your api pass>

Endpoint Coverage

The generated client includes methods for all documented callable Enduser API pages in the current docs snapshot, including areas such as:

• Virtual servers
• User and account management
• Statistics and profile
• DNS and reverse DNS
• VPS management, rescue, VNC, and recipes
• Domain forwarding and control panel operations
• SSH keys, ISO, backups, processes, API credentials, services, volumes, and VPS firewall

You can inspect the full generated catalogue through ENDUSER_ENDPOINTS and ENDUSER_GROUPS.

Full Endpoint List

The package currently includes 89 callable Enduser API endpoints grouped as follows:

Virtual Server (15)

• listVps() - List VPS - list-vps - Docs
• vpsInfo() - VPS Info - vps-info - Docs
• createVm() - Create VM - create-vm - Docs
• editVm() - Edit VM - edit-vm - Docs
• deleteVm() - Delete VM - delete-vm - Docs
• startVm() - Start VM - start-vm - Docs
• stopVm() - Stop VM - stop-vm - Docs
• restartVm() - Restart VM - restart-vm - Docs
• poweroffVm() - Poweroff VM - poweroff-vm - Docs
• suspendVm() - Suspend VM - suspend-vm - Docs
• unsuspendVm() - Unsuspend VM - unsuspend-vm - Docs
• networkSuspend() - Network Suspend - enduser-network-suspend - Docs
• networkUnsuspend() - Network Unsuspend - network-unsuspend - Docs
• verticalScalingData() - Vertical Scaling Data - vertical-scaling-data - Docs
• cloudResources() - Cloud Resources - cloud-resources - Docs

User (8)

• listUser() - List User - list-user - Docs
• addUser() - Add User - enduser-add-user - Docs
• editUser() - Edit User - enduser-edit-user - Docs
• deleteUser() - Delete User - enduser-delete-user - Docs
• singleSignOnSso() - Single Sign On (SSO) - single-sign-on-sso - Docs
• cloudBilling() - Cloud Billing - cloud-billing - Docs
• userSettings() - User Settings - user-settings - Docs
• accountPassword() - Account Password - account-password - Docs

Statistics (5)

• ram() - Ram - enduser-ram - Docs
• cpu() - CPU - enduser-cpu - Docs
• disk() - Disk - enduser-disk - Docs
• bandwidth() - Bandwidth - enduser-bandwidth - Docs
• profile() - Profile - profile - Docs

DNS (3)

• listDnsServer() - List DNS Server - list-dns-server - Docs
• addDnsServer() - ADD DNS - add-dns-server - Docs
• deleteDns() - Delete DNS - delete-dns - Docs

DNS Record (4)

• zoneInfo() - Zone Info - zone-info - Docs
• addDnsRecord() - Add DNS Record - add-dns-record - Docs
• editDnsRecord() - Edit DNS Record - edit-dns-record - Docs
• deleteDnsRecord() - Delete DNS Record - delete-dns-record - Docs

Reverse DNS (3)

• listReverseDns() - List Reverse DNS - list-reverse-dns - Docs
• addReverseDns() - Add Reverse DNS - add-reverse-dns - Docs
• deleteReverseDns() - Delete Reverse DNS - delete-reverse-dns - Docs

VPS Management (5)

• changeHostname() - Change Hostname - change-hostname - Docs
• changePassword() - Change Password - change-password - Docs
• vpsConfiguration() - VPS Configuration - vps-configuration - Docs
• ip() - IP - ip - Docs
• manageSubnets() - Manage Subnets - manage-subnets - Docs

Rescue (2)

• enableRescue() - Enable Rescue - enable-rescue - Docs
• disableRescue() - Disable Rescue - disable-rescue - Docs

VNC (2)

• vncInfo() - VNC Info - enduser-vnc-info - Docs
• vncPassword() - VNC Password - vnc-password - Docs

Recipes (2)

• listRecipes() - List Recipes - enduser-list-recipes - Docs
• executeRecipe() - Execute Recipe - execute-recipe - Docs

Domain Forwarding (4)

• listDomainForwarding() - List Domain Forwarding - list-domain-forwarding - Docs
• addDomainForwarding() - Add Domain Forwarding - add-domain-forwarding - Docs
• editDomainForwarding() - Edit Domain Forwarding - edit-domain-forwarding - Docs
• deleteDomainForwarding() - Delete Domain Forwarding - delete-domain-forwarding - Docs

Applications (4)

• webuzoScripts() - Webuzo Scripts - webuzo-scripts - Docs
• monitor() - Monitor - monitor - Docs
• statusLogs() - Status Logs - status-logs - Docs
• logs() - Logs - logs - Docs

Self Shutdown (5)

• startSelfShutdown() - Start Self Shutdown - start-self-shutdown - Docs
• deleteSelfShutdown() - Delete Self Shutdown - delete-self-shutdown - Docs
• tasks() - Tasks - tasks - Docs
• osReinstall() - OS Reinstall - os-reinstall - Docs
• controlPanel() - Control Panel - control-panel - Docs

SSH Keys (6)

• listSshKeys() - List SSH keys - list-ssh-keys - Docs
• addSshKey() - Add SSH key - add-ssh-key - Docs
• editSshKey() - Edit SSH key - edit-ssh-key - Docs
• deleteSshKey() - Delete SSH key - delete-ssh-key - Docs
• applySshKey() - Apply SSH key - apply-ssh-key - Docs
• generateKeys() - Generate Keys - generate-keys - Docs

ISO (3)

• listIso() - List ISO - enduser-list-iso - Docs
• addIso() - Add ISO - enduser-add-iso - Docs
• deleteIso() - Delete ISO - enduser-delete-iso - Docs

Backups (4)

• listBackup() - List backup - list-backup - Docs
• createBackup() - Create backup - create-backup - Docs
• restoringBackup() - Restoring backup - restoring-backup - Docs
• deleteBackup() - Delete Backup - delete-backup - Docs

Processes (2)

• listProcesses() - List Processes - enduser-list-processes - Docs
• killProcesses() - Kill Processes - enduser-kill-processes - Docs

API Credentials (4)

• listApiKey() - List API key - list-api-key - Docs
• addApiKey() - Add API Key - add-api-key - Docs
• deleteApiKey() - Delete API Key - delete-api-key - Docs
• systemAlerts() - System Alerts - system-alerts - Docs

Services (4)

• listServices() - List Services - enduser-list-services - Docs
• startService() - Start Service - start-service - Docs
• stopServices() - Stop Services - stop-services - Docs
• restartServices() - Restart Services - enduser-restart-services - Docs

Volumes (4)

• listVolumes() - List volumes - list-volumes - Docs
• addVolume() - Add volume - add-volume - Docs
• editVolume() - Edit volume - edit-volume - Docs
• deleteVolume() - Delete volume - delete-volume - Docs

Development

npm install
npm run generate
npm run build
npm test

npm run generate refreshes the endpoint metadata from the official Virtualizor docs.

Sponsored by Systey