Model Context Protocol (MCP) server for Hostinger API.

• Node.js version 24 or higher

If you don't have Node.js installed, you can download it from the official website. Alternatively, you can use a package manager like Homebrew (for macOS) or Chocolatey (for Windows) to install Node.js.

We recommend using NVM (Node Version Manager) to install and manage installed Node.js versions. After installing NVM, you can install Node.js with the following command:

nvm install v24
nvm use v24

To install the MCP server, run one of the following command, depending on your package manager:

# Install globally from npm
npm install -g hostinger-api-mcp

# Or with yarn
yarn global add hostinger-api-mcp

# Or with pnpm
pnpm add -g hostinger-api-mcp

To update the MCP server to the latest version, use one of the following commands, depending on your package manager:

# Update globally from npm
npm update -g hostinger-api-mcp

# Or with yarn
yarn global upgrade hostinger-api-mcp

# Or with pnpm
pnpm update -g hostinger-api-mcp

The following environment variables can be configured when running the server:

• DEBUG: Enable debug logging (true/false) (default: false)
• API_TOKEN: Your API token, which will be sent in the Authorization header.

{
    "mcpServers": {
        "hostinger-api": {
            "command": "hostinger-api-mcp",
            "env": {
                "DEBUG": "false",
                "API_TOKEN": "YOUR API TOKEN"
            }
        }
    }
}

The MCP server supports two transport modes:

The server can use standard input / output (stdio) transport (default). This provides local streaming:

The server can use HTTP streaming transport. This provides bidirectional streaming over HTTP:

# Default HTTP transport on localhost:8100
hostinger-api-mcp --http

# Specify custom host and port
hostinger-api-mcp --http --host 0.0.0.0 --port 8150

Options:
  --http           Use HTTP streaming transport
  --stdio          Use Server-Sent Events transport (default)
  --host {host}    Hostname or IP address to listen on (default: 127.0.0.1)
  --port {port}    Port to bind to (default: 8100)
  --help           Show help message

This server implements the Model Context Protocol (MCP) and can be used with any MCP-compatible consumer.

Example of connecting to this server using HTTP streaming transport:

import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";

// Create HTTP transport
const transport = new StreamableHTTPClientTransport({
  url: "http://localhost:8100/",
  headers: {
    "Authorization": `Bearer ${process.env.API_TOKEN}`
  }
});

// Connect to the MCP server
const client = new Client({
  name: "my-client",
  version: "1.0.0"
}, {
  capabilities: {}
});

await client.connect(transport);

// List available tools
const { tools } = await client.listTools();
console.log("Available tools:", tools);

// Call a tool
const result = await client.callTool({
  name: "billing_getCatalogItemListV1",
  arguments: { category: "DOMAIN" }
});
console.log("Tool result:", result);

This MCP server provides the following tools:

Retrieve catalog items available for order.

Prices in catalog items is displayed as cents (without floating point), e.g: float 17.99 is displayed as integer 1799.

Use this endpoint to view available services and pricing before placing orders.

• Method: GET
• Path: /api/billing/v1/catalog

Parameters:

• category: Filter catalog items by category
• name: Filter catalog items by name. Use * for wildcard search, e.g. .COM* to find .com domain

Create a new service order.

DEPRECATED

To purchase a domain, use POST /api/domains/v1/portfolio instead.

To purchase a VPS, use POST /api/vps/v1/virtual-machines instead.

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 credit_card payments might need additional verification, rendering purchase unprocessed. We recommend use other payment methods than credit_card if you encounter this issue.

• Method: POST
• Path: /api/billing/v1/orders

Parameters:

• payment_method_id: Payment method ID (required)
• items: items parameter (required)
• coupons: Discount coupon codes

Set the default payment method for your account.

Use this endpoint to configure the primary payment method for future orders.

• Method: POST
• Path: /api/billing/v1/payment-methods/{paymentMethodId}

Parameters:

• paymentMethodId: Payment method ID (required)

Delete a payment method from your account.

Use this endpoint to remove unused payment methods from user accounts.

• Method: DELETE
• Path: /api/billing/v1/payment-methods/{paymentMethodId}

Parameters:

• paymentMethodId: Payment method ID (required)

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.

• Method: GET
• Path: /api/billing/v1/payment-methods

Cancel a subscription and stop any further billing.

Use this endpoint when users want to terminate active services.

• Method: DELETE
• Path: /api/billing/v1/subscriptions/{subscriptionId}

Parameters:

• subscriptionId: Subscription ID (required)

Retrieve a list of all subscriptions associated with your account.

Use this endpoint to monitor active services and billing status.

• Method: GET
• Path: /api/billing/v1/subscriptions

Retrieve particular DNS snapshot with contents of DNS zone records.

Use this endpoint to view historical DNS configurations for domains.

• Method: GET
• Path: /api/dns/v1/snapshots/{domain}/{snapshotId}

Parameters:

• domain: Domain name (required)
• snapshotId: Snapshot ID (required)

Retrieve DNS snapshots for a domain.

Use this endpoint to view available DNS backup points for restoration.

• Method: GET
• Path: /api/dns/v1/snapshots/{domain}

Parameters:

• domain: Domain name (required)

Restore DNS zone to the selected snapshot.

Use this endpoint to revert domain DNS to a previous configuration.

• Method: POST
• Path: /api/dns/v1/snapshots/{domain}/{snapshotId}/restore

Parameters:

• domain: Domain name (required)
• snapshotId: Snapshot ID (required)

Retrieve DNS zone records for a specific domain.

Use this endpoint to view current DNS configuration for domain management.

• Method: GET
• Path: /api/dns/v1/zones/{domain}

Parameters:

• domain: Domain name (required)

Update DNS records for the selected domain.

Using overwrite = true will replace existing records with the provided ones. Otherwise existing records will be updated and new records will be added.

Use this endpoint to modify domain DNS configuration.

• Method: PUT
• Path: /api/dns/v1/zones/{domain}

Parameters:

• domain: Domain name (required)
• overwrite: If true, resource records (RRs) matching name and type will be deleted and new RRs will be created, otherwise resource records' ttl's are updated and new records are appended. If no matching RRs are found, they are created.
• zone: zone parameter (required)

Delete DNS records for the selected domain.

To filter which records to delete, add the name of the record and type to the filter. Multiple filters can be provided with single request.

If you have multiple records with the same name and type, and you want to delete only part of them, refer to the Update zone records endpoint.

Use this endpoint to remove specific DNS records from domains.

• Method: DELETE
• Path: /api/dns/v1/zones/{domain}

Parameters:

• domain: Domain name (required)

Reset DNS zone to the default records.

Use this endpoint to restore domain DNS to original configuration.

• Method: POST
• Path: /api/dns/v1/zones/{domain}/reset

Parameters:

• domain: Domain name (required)
• sync: Determines if operation should be run synchronously
• reset_email_records: Determines if email records should be reset
• whitelisted_record_types: Specifies which record types to not reset

Validate DNS records prior to update for the selected domain.

If the validation is successful, the response will contain 200 Success code. If there is validation error, the response will fail with 422 Validation error code.

Use this endpoint to verify DNS record validity before applying changes.

• Method: POST
• Path: /api/dns/v1/zones/{domain}/validate

Parameters:

• domain: Domain name (required)
• overwrite: If true, resource records (RRs) matching name and type will be deleted and new RRs will be created, otherwise resource records' ttl's are updated and new records are appended. If no matching RRs are found, they are created.
• zone: zone parameter (required)

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 with_alternatives to true. TLDs should be provided without leading dot (e.g. com, net, org).

Endpoint has rate limit of 10 requests per minute.

Use this endpoint to verify domain availability before purchase.

• Method: POST
• Path: /api/domains/v1/availability

Parameters:

• domain: Domain name (without TLD) (required)
• tlds: TLDs list (required)
• with_alternatives: Should response include alternatives

Retrieve domain forwarding data.

Use this endpoint to view current redirect configuration for domains.

• Method: GET
• Path: /api/domains/v1/forwarding/{domain}

Parameters:

• domain: Domain name (required)

Delete domain forwarding data.

Use this endpoint to remove redirect configuration from domains.

• Method: DELETE
• Path: /api/domains/v1/forwarding/{domain}

Parameters:

• domain: Domain name (required)

Create domain forwarding configuration.

Use this endpoint to set up domain redirects to other URLs.

• Method: POST
• Path: /api/domains/v1/forwarding

Parameters:

• domain: Domain name (required)
• redirect_type: Redirect type (required)
• redirect_url: URL to forward domain to (required)

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.

• Method: PUT
• Path: /api/domains/v1/portfolio/{domain}/domain-lock

Parameters:

• domain: Domain name (required)

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.

• Method: DELETE
• Path: /api/domains/v1/portfolio/{domain}/domain-lock

Parameters:

• domain: Domain name (required)

Retrieve detailed information for specified domain.

Use this endpoint to view comprehensive domain configuration and status.

• Method: GET
• Path: /api/domains/v1/portfolio/{domain}

Parameters:

• domain: Domain name (required)

Retrieve all domains associated with your account.

Use this endpoint to view user's domain portfolio.

• Method: GET
• Path: /api/domains/v1/portfolio

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 additional_details to be provided and these will be validated before completing purchase.

Use this endpoint to register new domains for users.

• Method: POST
• Path: /api/domains/v1/portfolio

Parameters:

• domain: Domain name (required)
• item_id: Catalog price item ID (required)
• payment_method_id: Payment method ID, default will be used if not provided
• domain_contacts: Domain contact information
• additional_details: Additional registration data, possible values depends on TLD
• coupons: Discount coupon codes

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.

• Method: PUT
• Path: /api/domains/v1/portfolio/{domain}/privacy-protection

Parameters:

• domain: Domain name (required)

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.

• Method: DELETE
• Path: /api/domains/v1/portfolio/{domain}/privacy-protection

Parameters:

• domain: Domain name (required)

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.

• Method: PUT
• Path: /api/domains/v1/portfolio/{domain}/nameservers

Parameters:

• domain: Domain name (required)
• ns1: First name server (required)
• ns2: Second name server (required)
• ns3: Third name server
• ns4: Fourth name server

Retrieve a WHOIS contact profile.

Use this endpoint to view domain registration contact information.

• Method: GET
• Path: /api/domains/v1/whois/{whoisId}

Parameters:

• whoisId: WHOIS ID (required)

Delete WHOIS contact profile.

Use this endpoint to remove unused contact profiles from account.

• Method: DELETE
• Path: /api/domains/v1/whois/{whoisId}

Parameters:

• whoisId: WHOIS ID (required)

Retrieve WHOIS contact profiles.

Use this endpoint to view available contact profiles for domain registration.

• Method: GET
• Path: /api/domains/v1/whois

Parameters:

• tld: Filter by TLD (without leading dot)

Create WHOIS contact profile.

Use this endpoint to add new contact information for domain registration.

• Method: POST
• Path: /api/domains/v1/whois

Parameters:

• tld: TLD of the domain (without leading dot) (required)
• country: ISO 3166 2-letter country code (required)
• entity_type: Legal entity type (required)
• tld_details: TLD details
• whois_details: WHOIS details (required)

Retrieve domain list where provided WHOIS contact profile is used.

Use this endpoint to view which domains use specific contact profiles.

• Method: GET
• Path: /api/domains/v1/whois/{whoisId}/usage

Parameters:

• whoisId: WHOIS ID (required)

Retrieve all available data centers.

Use this endpoint to view location options before deploying VPS instances.

• Method: GET
• Path: /api/vps/v1/data-centers

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.

• Method: GET
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/containers

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• projectName: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)

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.

• Method: GET
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• projectName: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)

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.

• Method: DELETE
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/down

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• projectName: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)

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.

• Method: GET
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/docker

Parameters:

• virtualMachineId: Virtual Machine ID (required)

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.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/docker

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• project_name: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)
• content: URL pointing to docker-compose.yaml file, Github repository or raw YAML content of the compose file (required)

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.

• Method: GET
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/logs

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• projectName: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)

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.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/restart

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• projectName: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)

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.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/start

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• projectName: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)

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.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/stop

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• projectName: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)

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.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/update

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• projectName: Docker Compose project name using alphanumeric characters, dashes, and underscores only (required)

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.

• Method: POST
• Path: /api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}

Parameters:

• firewallId: Firewall ID (required)
• virtualMachineId: Virtual Machine ID (required)

Deactivate a firewall for a specified virtual machine.

Use this endpoint to remove firewall protection from VPS instances.

• Method: POST
• Path: /api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}

Parameters:

• firewallId: Firewall ID (required)
• virtualMachineId: Virtual Machine ID (required)

Retrieve firewall by its ID and rules associated with it.

Use this endpoint to view specific firewall configuration and rules.

• Method: GET
• Path: /api/vps/v1/firewall/{firewallId}

Parameters:

• firewallId: Firewall ID (required)

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.

• Method: DELETE
• Path: /api/vps/v1/firewall/{firewallId}

Parameters:

• firewallId: Firewall ID (required)

Retrieve all available firewalls.

Use this endpoint to view existing firewall configurations.

• Method: GET
• Path: /api/vps/v1/firewall

Parameters:

• page: Page number

Create a new firewall.

Use this endpoint to set up new firewall configurations for VPS security.

• Method: POST
• Path: /api/vps/v1/firewall

Parameters:

• name: name parameter (required)

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.

• Method: PUT
• Path: /api/vps/v1/firewall/{firewallId}/rules/{ruleId}

Parameters:

• firewallId: Firewall ID (required)
• ruleId: Firewall Rule ID (required)
• protocol: protocol parameter (required)
• port: Port or port range, ex: 1024:2048 (required)
• source: source parameter (required)
• source_detail: IP range, CIDR, single IP or any (required)

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.

• Method: DELETE
• Path: /api/vps/v1/firewall/{firewallId}/rules/{ruleId}

Parameters:

• firewallId: Firewall ID (required)
• ruleId: Firewall Rule ID (required)

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.

• Method: POST
• Path: /api/vps/v1/firewall/{firewallId}/rules

Parameters:

• firewallId: Firewall ID (required)
• protocol: protocol parameter (required)
• port: Port or port range, ex: 1024:2048 (required)
• source: source parameter (required)
• source_detail: IP range, CIDR, single IP or any (required)

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.

• Method: POST
• Path: /api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}

Parameters:

• firewallId: Firewall ID (required)
• virtualMachineId: Virtual Machine ID (required)

Retrieve post-install script by its ID.

Use this endpoint to view specific automation script details.

• Method: GET
• Path: /api/vps/v1/post-install-scripts/{postInstallScriptId}

Parameters:

• postInstallScriptId: Post-install script ID (required)

Update a specific post-install script.

Use this endpoint to modify existing automation scripts.

• Method: PUT
• Path: /api/vps/v1/post-install-scripts/{postInstallScriptId}

Parameters:

• postInstallScriptId: Post-install script ID (required)
• name: Name of the script (required)
• content: Content of the script (required)

Delete a post-install script from your account.

Use this endpoint to remove unused automation scripts.

• Method: DELETE
• Path: /api/vps/v1/post-install-scripts/{postInstallScriptId}

Parameters:

• postInstallScriptId: Post-install script ID (required)

Retrieve post-install scripts associated with your account.

Use this endpoint to view available automation scripts for VPS deployment.

• Method: GET
• Path: /api/vps/v1/post-install-scripts

Parameters:

• page: Page number

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 /post_install with executable attribute set and will be executed once virtual machine is installed. The output of the script will be redirected to /post_install.log. Maximum script size is 48KB.

Use this endpoint to create automation scripts for VPS setup tasks.

• Method: POST
• Path: /api/vps/v1/post-install-scripts

Parameters:

• name: Name of the script (required)
• content: Content of the script (required)

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.

• Method: POST
• Path: /api/vps/v1/public-keys/attach/{virtualMachineId}

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• ids: Public Key IDs to attach (required)

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.

• Method: DELETE
• Path: /api/vps/v1/public-keys/{publicKeyId}

Parameters:

• publicKeyId: Public Key ID (required)

Retrieve public keys associated with your account.

Use this endpoint to view available SSH keys for VPS authentication.

• Method: GET
• Path: /api/vps/v1/public-keys

Parameters:

• page: Page number

Add a new public key to your account.

Use this endpoint to register SSH keys for VPS authentication.

• Method: POST
• Path: /api/vps/v1/public-keys

Parameters:

• name: name parameter (required)
• key: key parameter (required)

Retrieve detailed information about a specific OS template for virtual machines.

Use this endpoint to view specific template specifications before deployment.

• Method: GET
• Path: /api/vps/v1/templates/{templateId}

Parameters:

• templateId: Template ID (required)

Retrieve available OS templates for virtual machines.

Use this endpoint to view operating system options before creating or recreating VPS instances.

• Method: GET
• Path: /api/vps/v1/templates

Retrieve detailed information about a specific action performed on a specified virtual machine.

Use this endpoint to monitor specific VPS operation status and details.

• Method: GET
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• actionId: Action ID (required)

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.

• Method: GET
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/actions

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• page: Page number

Retrieve public keys attached to a specified virtual machine.

Use this endpoint to view SSH keys configured for specific VPS instances.

• Method: GET
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/public-keys

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• page: Page number

Retrieve backups for a specified virtual machine.

Use this endpoint to view available backup points for VPS data recovery.

• Method: GET
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/backups

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• page: Page number

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.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• backupId: Backup ID (required)

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.

• Method: PUT
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/hostname

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• hostname: hostname parameter (required)

Reset hostname and PTR record of a specified virtual machine to default value.

Use this endpoint to restore default hostname configuration for VPS instances.

• Method: DELETE
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/hostname

Parameters:

• virtualMachineId: Virtual Machine ID (required)

Retrieve detailed information about a specified virtual machine.

Use this endpoint to view comprehensive VPS configuration and status.

• Method: GET
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}

Parameters:

• virtualMachineId: Virtual Machine ID (required)

Retrieve all available virtual machines.

Use this endpoint to view available VPS instances.

• Method: GET
• Path: /api/vps/v1/virtual-machines

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.

• Method: POST
• Path: /api/vps/v1/virtual-machines

Parameters:

• item_id: Catalog price item ID (required)
• payment_method_id: Payment method ID, default will be used if not provided
• setup: setup parameter (required)
• coupons: Discount coupon codes

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.

• Method: GET
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/monarx

Parameters:

• virtualMachineId: Virtual Machine ID (required)

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.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/monarx

Parameters:

• virtualMachineId: Virtual Machine ID (required)

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.

• Method: DELETE
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/monarx

Parameters:

• virtualMachineId: Virtual Machine ID (required)

Retrieve historical metrics for a specified virtual machine.

It includes the following metrics:

• CPU usage
• Memory usage
• Disk usage
• Network usage
• Uptime

Use this endpoint to monitor VPS performance and resource utilization over time.

• Method: GET
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/metrics

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• date_from: date_from parameter (required)
• date_to: date_to parameter (required)

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.

• Method: PUT
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/nameservers

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• ns1: ns1 parameter (required)
• ns2: ns2 parameter
• ns3: ns3 parameter

Create or update a PTR (Pointer) record for a specified virtual machine.

Use this endpoint to configure reverse DNS lookup for VPS IP addresses.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/ptr

Parameters:

• virtualMachineId: Virtual Machine ID (required)

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.

• Method: DELETE
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/ptr

Parameters:

• virtualMachineId: Virtual Machine ID (required)

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.

• Method: PUT
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/panel-password

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• password: Panel password for the virtual machine (required)

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 /mnt directory.

Use this endpoint to enable system rescue operations on VPS instances.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/recovery

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• root_password: Temporary root password for recovery mode (required)

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.

• Method: DELETE
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/recovery

Parameters:

• virtualMachineId: Virtual Machine ID (required)

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 will be checked against leaked password databases. Requirements for the password are:

• At least 8 characters long
• At least one uppercase letter
• At least one lowercase letter
• At least one number
• Is not leaked publicly

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.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/recreate

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• template_id: Template ID (required)
• password: Password for the virtual machine. If not provided, random password will be generated. Password will not be shown in the response.
• post_install_script_id: Post-install script ID

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.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/restart

Parameters:

• virtualMachineId: Virtual Machine ID (required)

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.

• Method: PUT
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/root-password

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• password: Root password for the virtual machine (required)

Setup newly purchased virtual machine with initial state.

Use this endpoint to configure and initialize purchased VPS instances.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/setup

Parameters:

• virtualMachineId: Virtual Machine ID (required)
• template_id: Template ID (required)
• data_center_id: Data center ID (required)
• post_install_script_id: Post-install script ID
• password: Password for the virtual machine. If not provided, random password will be generated. Password will not be shown in the response.
• hostname: Override default hostname of the virtual machine
• install_monarx: Install Monarx malware scanner (if supported)
• enable_backups: Enable weekly backup schedule
• ns1: Name server 1
• ns2: Name server 2
• public_key: Use SSH key

Retrieve snapshot for a specified virtual machine.

Use this endpoint to view current VPS snapshot information.

• Method: GET
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot

Parameters:

• virtualMachineId: Virtual Machine ID (required)

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.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot

Parameters:

• virtualMachineId: Virtual Machine ID (required)

Delete a snapshot of a specified virtual machine.

Use this endpoint to remove VPS snapshots.

• Method: DELETE
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot

Parameters:

• virtualMachineId: Virtual Machine ID (required)

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.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot/restore

Parameters:

• virtualMachineId: Virtual Machine ID (required)

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.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/start

Parameters:

• virtualMachineId: Virtual Machine ID (required)

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.

• Method: POST
• Path: /api/vps/v1/virtual-machines/{virtualMachineId}/stop

Parameters:

• virtualMachineId: Virtual Machine ID (required)