Server Configuration
Describes the environment variables required to run the server.
Name | Required | Description | Default |
---|---|---|---|
DEBUG | No | Enable debug logging (true/false) | false |
API_TOKEN | Yes | Your API token, which will be sent in the Authorization header |
Schema
Prompts
Interactive templates invoked by user choice
Name | Description |
---|---|
No prompts |
Resources
Contextual data attached and managed by the client
Name | Description |
---|---|
No resources |
Tools
Functions exposed to the LLM to take actions
Name | Description |
---|---|
billing_getCatalogItemListV1 | Retrieve catalog items available for order. Prices in catalog items is displayed as cents (without floating point), e.g: float Use this endpoint to view available services and pricing before placing orders. |
billing_createServiceOrderV1 | Create a new service order. DEPRECATED To purchase a domain, use To purchase a VPS, use To place order, you need to provide payment method ID and list of price items from the catalog endpoint together with quantity. Coupons also can be provided during order creation. Orders created using this endpoint will be set for automatic renewal. Some |
billing_setDefaultPaymentMethodV1 | Set the default payment method for your account. Use this endpoint to configure the primary payment method for future orders. |
billing_deletePaymentMethodV1 | Delete a payment method from your account. Use this endpoint to remove unused payment methods from user accounts. |
billing_getPaymentMethodListV1 | Retrieve available payment methods that can be used for placing new orders. If you want to add new payment method, please use hPanel. Use this endpoint to view available payment options before creating orders. |
billing_cancelSubscriptionV1 | Cancel a subscription and stop any further billing. Use this endpoint when users want to terminate active services. |
billing_getSubscriptionListV1 | Retrieve a list of all subscriptions associated with your account. Use this endpoint to monitor active services and billing status. |
DNS_getDNSSnapshotV1 | Retrieve particular DNS snapshot with contents of DNS zone records. Use this endpoint to view historical DNS configurations for domains. |
DNS_getDNSSnapshotListV1 | Retrieve DNS snapshots for a domain. Use this endpoint to view available DNS backup points for restoration. |
DNS_restoreDNSSnapshotV1 | Restore DNS zone to the selected snapshot. Use this endpoint to revert domain DNS to a previous configuration. |
DNS_getDNSRecordsV1 | Retrieve DNS zone records for a specific domain. Use this endpoint to view current DNS configuration for domain management. |
DNS_updateDNSRecordsV1 | Update DNS records for the selected domain. Using Use this endpoint to modify domain DNS configuration. |
DNS_deleteDNSRecordsV1 | Delete DNS records for the selected domain. To filter which records to delete, add the If you have multiple records with the same name and type, and you want to delete only part of them,
refer to the Use this endpoint to remove specific DNS records from domains. |
DNS_resetDNSRecordsV1 | Reset DNS zone to the default records. Use this endpoint to restore domain DNS to original configuration. |
DNS_validateDNSRecordsV1 | Validate DNS records prior to update for the selected domain. If the validation is successful, the response will contain Use this endpoint to verify DNS record validity before applying changes. |
domains_checkDomainAvailabilityV1 | Check availability of domain names across multiple TLDs. Multiple TLDs can be checked at once.
If you want alternative domains with response, provide only one TLD and set Endpoint has rate limit of 10 requests per minute. Use this endpoint to verify domain availability before purchase. |
domains_getDomainForwardingV1 | Retrieve domain forwarding data. Use this endpoint to view current redirect configuration for domains. |
domains_deleteDomainForwardingV1 | Delete domain forwarding data. Use this endpoint to remove redirect configuration from domains. |
domains_createDomainForwardingV1 | Create domain forwarding configuration. Use this endpoint to set up domain redirects to other URLs. |
domains_enableDomainLockV1 | Enable domain lock for the domain. When domain lock is enabled, the domain cannot be transferred to another registrar without first disabling the lock. Use this endpoint to secure domains against unauthorized transfers. |
domains_disableDomainLockV1 | Disable domain lock for the domain. Domain lock needs to be disabled before transferring the domain to another registrar. Use this endpoint to prepare domains for transfer to other registrars. |
domains_getDomainDetailsV1 | Retrieve detailed information for specified domain. Use this endpoint to view comprehensive domain configuration and status. |
domains_getDomainListV1 | Retrieve all domains associated with your account. Use this endpoint to view user's domain portfolio. |
domains_purchaseNewDomainV1 | Purchase and register a new domain name. If registration fails, login to hPanel and check domain registration status. If no payment method is provided, your default payment method will be used automatically. If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account. Some TLDs require Use this endpoint to register new domains for users. |
domains_enablePrivacyProtectionV1 | Enable privacy protection for the domain. When privacy protection is enabled, domain owner's personal information is hidden from public WHOIS database. Use this endpoint to protect domain owner's personal information from public view. |
domains_disablePrivacyProtectionV1 | Disable privacy protection for the domain. When privacy protection is disabled, domain owner's personal information is visible in public WHOIS database. Use this endpoint to make domain owner's information publicly visible. |
domains_updateDomainNameserversV1 | Set nameservers for a specified domain. Be aware, that improper nameserver configuration can lead to the domain being unresolvable or unavailable. Use this endpoint to configure custom DNS hosting for domains. |
domains_getWHOISProfileV1 | Retrieve a WHOIS contact profile. Use this endpoint to view domain registration contact information. |
domains_deleteWHOISProfileV1 | Delete WHOIS contact profile. Use this endpoint to remove unused contact profiles from account. |
domains_getWHOISProfileListV1 | Retrieve WHOIS contact profiles. Use this endpoint to view available contact profiles for domain registration. |
domains_createWHOISProfileV1 | Create WHOIS contact profile. Use this endpoint to add new contact information for domain registration. |
domains_getWHOISProfileUsageV1 | Retrieve domain list where provided WHOIS contact profile is used. Use this endpoint to view which domains use specific contact profiles. |
VPS_getDataCenterListV1 | Retrieve all available data centers. Use this endpoint to view location options before deploying VPS instances. |
VPS_getProjectContainersV1 | Retrieves a list of all containers belonging to a specific Docker Compose project on the virtual machine. This endpoint returns detailed information about each container including their current status, port mappings, and runtime configuration. Use this to monitor the health and state of all services within your Docker Compose project. |
VPS_getProjectContentsV1 | Retrieves the complete project information including the docker-compose.yml file contents, project metadata, and current deployment status. This endpoint provides the full configuration and state details of a specific Docker Compose project. Use this to inspect project settings, review the compose file, or check the overall project health. |
VPS_deleteProjectV1 | Completely removes a Docker Compose project from the virtual machine, stopping all containers and cleaning up associated resources including networks, volumes, and images. This operation is irreversible and will delete all project data. Use this when you want to permanently remove a project and free up system resources. |
VPS_getProjectListV1 | Retrieves a list of all Docker Compose projects currently deployed on the virtual machine. This endpoint returns basic information about each project including name, status, and file path. Use this to get an overview of all Docker projects on your VPS instance. |
VPS_createNewProjectV1 | Deploy new project from docker-compose.yaml contents or download contents from URL. URL can be Github repository url in format https://github.com/[user]/[repo] and it will be automatically resolved to docker-compose.yaml file in master branch. Any other URL provided must return docker-compose.yaml file contents. If project already exists, it will be replaced. |
VPS_getProjectLogsV1 | Retrieves aggregated log entries from all services within a Docker Compose project. This endpoint returns recent log output from each container, organized by service name with timestamps. The response contains the last 300 log entries across all services. Use this for debugging, monitoring application behavior, and troubleshooting issues across your entire project stack. |
VPS_restartProjectV1 | Restarts all services in a Docker Compose project by stopping and starting containers in the correct dependency order. This operation preserves data volumes and network configurations while refreshing the running containers. Use this to apply configuration changes or recover from service failures. |
VPS_startProjectV1 | Starts all services in a Docker Compose project that are currently stopped. This operation brings up containers in the correct dependency order as defined in the compose file. Use this to resume a project that was previously stopped or to start services after a system reboot. |
VPS_stopProjectV1 | Stops all running services in a Docker Compose project while preserving container configurations and data volumes. This operation gracefully shuts down containers in reverse dependency order. Use this to temporarily halt a project without removing data or configurations. |
VPS_updateProjectV1 | Updates a Docker Compose project by pulling the latest image versions and recreating containers with new configurations. This operation preserves data volumes while applying changes from the compose file. Use this to deploy application updates, apply configuration changes, or refresh container images to their latest versions. |
VPS_activateFirewallV1 | Activate a firewall for a specified virtual machine. Only one firewall can be active for a virtual machine at a time. Use this endpoint to apply firewall rules to VPS instances. |
VPS_deactivateFirewallV1 | Deactivate a firewall for a specified virtual machine. Use this endpoint to remove firewall protection from VPS instances. |
VPS_getFirewallDetailsV1 | Retrieve firewall by its ID and rules associated with it. Use this endpoint to view specific firewall configuration and rules. |
VPS_deleteFirewallV1 | Delete a specified firewall. Any virtual machine that has this firewall activated will automatically have it deactivated. Use this endpoint to remove unused firewall configurations. |
VPS_getFirewallListV1 | Retrieve all available firewalls. Use this endpoint to view existing firewall configurations. |
VPS_createNewFirewallV1 | Create a new firewall. Use this endpoint to set up new firewall configurations for VPS security. |
VPS_updateFirewallRuleV1 | Update a specific firewall rule from a specified firewall. Any virtual machine that has this firewall activated will lose sync with the firewall and will have to be synced again manually. Use this endpoint to modify existing firewall rules. |
VPS_deleteFirewallRuleV1 | Delete a specific firewall rule from a specified firewall. Any virtual machine that has this firewall activated will lose sync with the firewall and will have to be synced again manually. Use this endpoint to remove specific firewall rules. |
VPS_createFirewallRuleV1 | Create new firewall rule for a specified firewall. By default, the firewall drops all incoming traffic, which means you must add accept rules for all ports you want to use. Any virtual machine that has this firewall activated will lose sync with the firewall and will have to be synced again manually. Use this endpoint to add new security rules to firewalls. |
VPS_syncFirewallV1 | Sync a firewall for a specified virtual machine. Firewall can lose sync with virtual machine if the firewall has new rules added, removed or updated. Use this endpoint to apply updated firewall rules to VPS instances. |
VPS_getPostInstallScriptV1 | Retrieve post-install script by its ID. Use this endpoint to view specific automation script details. |
VPS_updatePostInstallScriptV1 | Update a specific post-install script. Use this endpoint to modify existing automation scripts. |
VPS_deletePostInstallScriptV1 | Delete a post-install script from your account. Use this endpoint to remove unused automation scripts. |
VPS_getPostInstallScriptsV1 | Retrieve post-install scripts associated with your account. Use this endpoint to view available automation scripts for VPS deployment. |
VPS_createPostInstallScriptV1 | Add a new post-install script to your account, which can then be used after virtual machine installation. The script contents will be saved to the file Use this endpoint to create automation scripts for VPS setup tasks. |
VPS_attachPublicKeyV1 | Attach existing public keys from your account to a specified virtual machine. Multiple keys can be attached to a single virtual machine. Use this endpoint to enable SSH key authentication for VPS instances. |
VPS_deletePublicKeyV1 | Delete a public key from your account. Deleting public key from account does not remove it from virtual machine Use this endpoint to remove unused SSH keys from account. |
VPS_getPublicKeysV1 | Retrieve public keys associated with your account. Use this endpoint to view available SSH keys for VPS authentication. |
VPS_createPublicKeyV1 | Add a new public key to your account. Use this endpoint to register SSH keys for VPS authentication. |
VPS_getTemplateDetailsV1 | Retrieve detailed information about a specific OS template for virtual machines. Use this endpoint to view specific template specifications before deployment. |
VPS_getTemplatesV1 | Retrieve available OS templates for virtual machines. Use this endpoint to view operating system options before creating or recreating VPS instances. |
VPS_getActionDetailsV1 | Retrieve detailed information about a specific action performed on a specified virtual machine. Use this endpoint to monitor specific VPS operation status and details. |
VPS_getActionsV1 | Retrieve actions performed on a specified virtual machine. Actions are operations or events that have been executed on the virtual machine, such as starting, stopping, or modifying the machine. This endpoint allows you to view the history of these actions, providing details about each action, such as the action name, timestamp, and status. Use this endpoint to view VPS operation history and troubleshoot issues. |
VPS_getAttachedPublicKeysV1 | Retrieve public keys attached to a specified virtual machine. Use this endpoint to view SSH keys configured for specific VPS instances. |
VPS_getBackupsV1 | Retrieve backups for a specified virtual machine. Use this endpoint to view available backup points for VPS data recovery. |
VPS_restoreBackupV1 | Restore a backup for a specified virtual machine. The system will then initiate the restore process, which may take some time depending on the size of the backup. All data on the virtual machine will be overwritten with the data from the backup. Use this endpoint to recover VPS data from backup points. |
VPS_setHostnameV1 | Set hostname for a specified virtual machine. Changing hostname does not update PTR record automatically. If you want your virtual machine to be reachable by a hostname, you need to point your domain A/AAAA records to virtual machine IP as well. Use this endpoint to configure custom hostnames for VPS instances. |
VPS_resetHostnameV1 | Reset hostname and PTR record of a specified virtual machine to default value. Use this endpoint to restore default hostname configuration for VPS instances. |
VPS_getVirtualMachineDetailsV1 | Retrieve detailed information about a specified virtual machine. Use this endpoint to view comprehensive VPS configuration and status. |
VPS_getVirtualMachinesV1 | Retrieve all available virtual machines. Use this endpoint to view available VPS instances. |
VPS_purchaseNewVirtualMachineV1 | Purchase and setup a new virtual machine. If virtual machine setup fails for any reason, login to hPanel and complete the setup manually. If no payment method is provided, your default payment method will be used automatically. Use this endpoint to create new VPS instances. |
VPS_getScanMetricsV1 | Retrieve scan metrics for the Monarx malware scanner installed on a specified virtual machine. The scan metrics provide detailed information about malware scans performed by Monarx, including number of scans, detected threats, and other relevant statistics. This information is useful for monitoring security status of the virtual machine and assessing effectiveness of the malware scanner. Use this endpoint to monitor VPS security scan results and threat detection. |
VPS_installMonarxV1 | Install the Monarx malware scanner on a specified virtual machine. Monarx is a security tool designed to detect and prevent malware infections on virtual machines. By installing Monarx, users can enhance the security of their virtual machines, ensuring that they are protected against malicious software. Use this endpoint to enable malware protection on VPS instances. |
VPS_uninstallMonarxV1 | Uninstall the Monarx malware scanner on a specified virtual machine. If Monarx is not installed, the request will still be processed without any effect. Use this endpoint to remove malware scanner from VPS instances. |
VPS_getMetricsV1 | Retrieve historical metrics for a specified virtual machine. It includes the following metrics:
Use this endpoint to monitor VPS performance and resource utilization over time. |
VPS_setNameserversV1 | Set nameservers for a specified virtual machine. Be aware, that improper nameserver configuration can lead to the virtual machine being unable to resolve domain names. Use this endpoint to configure custom DNS resolvers for VPS instances. |
VPS_createPTRRecordV1 | Create or update a PTR (Pointer) record for a specified virtual machine. Use this endpoint to configure reverse DNS lookup for VPS IP addresses. |
VPS_deletePTRRecordV1 | Delete a PTR (Pointer) record for a specified virtual machine. Once deleted, reverse DNS lookups to the virtual machine's IP address will no longer return the previously configured hostname. Use this endpoint to remove reverse DNS configuration from VPS instances. |
VPS_setPanelPasswordV1 | Set panel password for a specified virtual machine. If virtual machine does not use panel OS, the request will still be processed without any effect. Requirements for password are same as in the recreate virtual machine endpoint. Use this endpoint to configure control panel access credentials for VPS instances. |
VPS_startRecoveryModeV1 | Initiate recovery mode for a specified virtual machine. Recovery mode is a special state that allows users to perform system rescue operations, such as repairing file systems, recovering data, or troubleshooting issues that prevent the virtual machine from booting normally. Virtual machine will boot recovery disk image and original disk image will be mounted in Use this endpoint to enable system rescue operations on VPS instances. |
VPS_stopRecoveryModeV1 | Stop recovery mode for a specified virtual machine. If virtual machine is not in recovery mode, this operation will fail. Use this endpoint to exit system rescue mode and return VPS to normal operation. |
VPS_recreateVirtualMachineV1 | Recreate a virtual machine from scratch. The recreation process involves reinstalling the operating system and resetting the virtual machine to its initial state. Snapshots, if there are any, will be deleted. Password RequirementsPassword will be checked against leaked password databases. Requirements for the password are:
This operation is irreversible and will result in the loss of all data stored on the virtual machine! Use this endpoint to completely rebuild VPS instances with fresh OS installation. |
VPS_restartVirtualMachineV1 | Restart a specified virtual machine by fully stopping and starting it. If the virtual machine was stopped, it will be started. Use this endpoint to reboot VPS instances. |
VPS_setRootPasswordV1 | Set root password for a specified virtual machine. Requirements for password are same as in the recreate virtual machine endpoint. Use this endpoint to update administrator credentials for VPS instances. |
VPS_setupPurchasedVirtualMachineV1 | Setup newly purchased virtual machine with Use this endpoint to configure and initialize purchased VPS instances. |
VPS_getSnapshotV1 | Retrieve snapshot for a specified virtual machine. Use this endpoint to view current VPS snapshot information. |
VPS_createSnapshotV1 | Create a snapshot of a specified virtual machine. A snapshot captures the state and data of the virtual machine at a specific point in time, allowing users to restore the virtual machine to that state if needed. This operation is useful for backup purposes, system recovery, and testing changes without affecting the current state of the virtual machine. Creating new snapshot will overwrite the existing snapshot! Use this endpoint to capture VPS state for backup and recovery purposes. |
VPS_deleteSnapshotV1 | Delete a snapshot of a specified virtual machine. Use this endpoint to remove VPS snapshots. |
VPS_restoreSnapshotV1 | Restore a specified virtual machine to a previous state using a snapshot. Restoring from a snapshot allows users to revert the virtual machine to that state, which is useful for system recovery, undoing changes, or testing. Use this endpoint to revert VPS instances to previous saved states. |
VPS_startVirtualMachineV1 | Start a specified virtual machine. If the virtual machine is already running, the request will still be processed without any effect. Use this endpoint to power on stopped VPS instances. |
VPS_stopVirtualMachineV1 | Stop a specified virtual machine. If the virtual machine is already stopped, the request will still be processed without any effect. Use this endpoint to power off running VPS instances. |