Server Configuration
Describes the environment variables required to run the server.
Name | Required | Description | Default |
---|---|---|---|
DEBUG | No | Enable debug logging (true/false) | false |
APITOKEN | 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 | This endpoint retrieves a list of catalog items available for order. Prices in catalog items is displayed as cents (without floating point), e.g: float |
billing_createNewServiceOrderV1 | This endpoint creates a new service order. 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 | This endpoint sets default payment method for your account. |
billing_deletePaymentMethodV1 | This endpoint deletes a payment method from your account. |
billing_getPaymentMethodListV1 | This endpoint retrieves a list of available payment methods that can be used for placing new orders. If you want to add new payment method, please use hPanel. |
billing_cancelSubscriptionV1 | This endpoint cancels a subscription and stops any further billing. |
billing_getSubscriptionListV1 | This endpoint retrieves a list of all subscriptions associated with your account. |
DNS_getSnapshotV1 | This endpoint retrieves particular DNS snapshot with the contents of DNS zone records. |
DNS_getSnapshotListV1 | This endpoint retrieves list of DNS snapshots. |
DNS_restoreSnapshotV1 | This endpoint restores DNS zone to the selected snapshot. |
DNS_getRecordsV1 | This endpoint retrieves DNS zone records for a specific domain. |
DNS_updateZoneRecordsV1 | This endpoint updates DNS records for the selected domain. Using |
DNS_deleteZoneRecordsV1 | This endpoint deletes 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 |
DNS_resetZoneRecordsV1 | This endpoint resets DNS zone to the default records. |
DNS_validateZoneRecordsV1 | This endpoint used to validate DNS records prior update for the selected domain. If the validation is successful, the response will contain |
domains_checkDomainAvailabilityV1 | This endpoint checks the availability of a domain name. Multiple TLDs can be checked at once. Endpoint has rate limit of 10 requests per minute. |
domains_getDomainListV1 | This endpoint retrieves a list of all domains associated with your account. |
VPS_getDataCentersListV1 | This endpoint retrieves a list of all data centers available. |
VPS_activateFirewallV1 | This endpoint activates a firewall for a specified virtual machine. Only one firewall can be active for a virtual machine at a time. |
VPS_deactivateFirewallV1 | This endpoint deactivates a firewall for a specified virtual machine. |
VPS_getFirewallV1 | This endpoint retrieves firewall by its ID and rules associated with it. |
VPS_deleteFirewallV1 | This endpoint deletes a specified firewall. Any virtual machine that has this firewall activated will automatically have it deactivated. |
VPS_getFirewallListV1 | This endpoint retrieves a list of all firewalls available. |
VPS_createNewFirewallV1 | This endpoint creates a new firewall. |
VPS_updateFirewallRuleV1 | This endpoint updates a specific firewall rule from a specified firewall. Any virtual machine that has this firewall activated will loose sync with the firewall and will have to be synced again manually. |
VPS_deleteFirewallRuleV1 | This endpoint deletes a specific firewall rule from a specified firewall. Any virtual machine that has this firewall activated will loose sync with the firewall and will have to be synced again manually. |
VPS_createFirewallRuleV1 | This endpoint creates new firewall rule from 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 loose sync with the firewall and will have to be synced again manually. |
VPS_syncFirewallV1 | This endpoint syncs a firewall for a specified virtual machine. Firewall can loose sync with virtual machine if the firewall has new rules added, removed or updated. |
VPS_getPostInstallScriptV1 | This endpoint retrieves post-install script by its ID. |
VPS_updatePostInstallScriptV1 | This endpoint updates a specific post-install script. |
VPS_deleteAPostInstallScriptV1 | This endpoint deletes a post-install script from your account. |
VPS_getPostInstallScriptListV1 | This endpoint retrieves a list of post-install scripts associated with your account. |
VPS_createPostInstallScriptV1 | This endpoint allows you to add a new post-install script to your account, which can then be used run after the installation of a virtual machine instance. The script contents will be saved to the file |
VPS_attachPublicKeyV1 | This endpoint attaches an existing public keys from your account to a specified virtual machine. Multiple keys can be attached to a single virtual machine. |
VPS_deleteAPublicKeyV1 | This endpoint deletes a public key from your account. Deleting public key from account does not remove it from virtual machine |
VPS_getPublicKeyListV1 | This endpoint retrieves a list of public keys associated with your account. |
VPS_createNewPublicKeyV1 | This endpoint allows you to add a new public key to your account, which can then be attached to virtual machine instances for secure access. |
VPS_getTemplateV1 | This endpoint retrieves details of a specific OS template for virtual machines. |
VPS_getTemplateListV1 | This endpoint retrieves a list of available OS templates for virtual machines. |
VPS_getActionV1 | This endpoint retrieves details of a specific action performed on a specified virtual machine. This endpoint allows you to view detailed information about a particular action, including the action name, timestamp, and status. |
VPS_getActionListV1 | This endpoint retrieves a list of 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. |
VPS_getAttachedPublicKeysV1 | This endpoint retrieves a list of public keys attached to a specified virtual machine. |
VPS_deleteBackupV1 | This endpoint deletes a specified backup for a virtual machine. |
VPS_getBackupListV1 | This endpoint retrieves a list of backups for a specified virtual machine. |
VPS_restoreBackupV1 | This endpoint restores 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. |
VPS_setHostnameV1 | This endpoint sets the 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. |
VPS_resetHostnameV1 | This endpoint resets the hostname and PTR record of a specified virtual machine to the default value. |
VPS_getVirtualMachineV1 | This endpoint retrieves detailed information about a specified virtual machine. |
VPS_getVirtualMachineListV1 | This endpoint retrieves a list of all available virtual machines. |
VPS_getScanMetricsV1 | This endpoint retrieves the scan metrics for the Monarx malware scanner installed on a specified virtual machine. The scan metrics provide detailed information about the malware scans performed by Monarx, including the number of scans, detected threats, and other relevant statistics. This information is useful for monitoring the security status of the virtual machine and assessing the effectiveness of the malware scanner. |
VPS_installMonarxV1 | This endpoint installs 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. |
VPS_uninstallMonarxV1 | This endpoint uninstalls the Monarx malware scanner on a specified virtual machine. If Monarx is not installed, the request will still be processed without any effect. |
VPS_getMetricsV1 | This endpoint retrieves the historical metrics for a specified virtual machine. It includes the following metrics:
|
VPS_setNameserversV1 | This endpoint sets the nameservers for a specified virtual machine. Be aware, that improper nameserver configuration can lead to the virtual machine being unable to resolve domain names. |
VPS_createPTRRecordV1 | This endpoint creates or updates a PTR (Pointer) record for a specified virtual machine. |
VPS_deletePTRRecordV1 | This endpoint deletes 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. |
VPS_setPanelPasswordV1 | This endpoint sets the 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 the password is the same as in the recreate virtual machine endpoint. |
VPS_startRecoveryModeV1 | This endpoint initiates the 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 |
VPS_stopRecoveryModeV1 | This endpoint stops the recovery mode for a specified virtual machine. If virtual machine is not in recovery mode, this operation will fail. |
VPS_recreateVirtualMachineV1 | This endpoint will 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! |
VPS_restartVirtualMachineV1 | This endpoint restarts a specified virtual machine. This is equivalent to fully stopping and starting the virtual machine. If the virtual machine was stopped, it will be started. |
VPS_setRootPasswordV1 | This endpoint sets the root password for a specified virtual machine. Requirements for the password is the same as in the recreate virtual machine endpoint. |
VPS_setupNewVirtualMachineV1 | This endpoint will setup newly purchased virtual machine. Such virtual machines has |
VPS_getSnapshotV1 | This endpoint retrieves a snapshot for a specified virtual machine. |
VPS_createSnapshotV1 | This endpoint creates 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! |
VPS_deleteSnapshotV1 | This endpoint deletes a snapshot of a specified virtual machine. |
VPS_restoreSnapshotV1 | This endpoint restores 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. |
VPS_startVirtualMachineV1 | This endpoint starts a specified virtual machine. If the virtual machine is already running, the request will still be processed without any effect. |
VPS_stopVirtualMachineV1 | This endpoint stops a specified virtual machine. If the virtual machine is already stopped, the request will still be processed without any effect. |