Api MCP Server

hostinger-api-mcp

Model Context Protocol (MCP) server for Hostinger API.

Prerequisites

• 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

Installation

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

Update

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

Configuration

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.

Usage

JSON configuration for Claude, Cursor, etc.

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

Transport Options

The MCP server supports two transport modes:

Standard I/O Transport

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

Streamable HTTP Transport

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

Command Line Options

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

Using as an MCP Tool Provider

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);

Available Tools

This MCP server provides the following tools:

hosting_importWordpressWebsite

Import a WordPress website from an archive file to a hosting server. This tool uploads a website archive (zip, tar, tar.gz, etc.) and a database dump (.sql file) to deploy a complete WordPress website. The archive will be extracted on the server automatically. Note: This process may take a while for larger sites. After upload completion, files are being extracted and the site will be available in a few minutes. The username will be automatically resolved from the domain.

• Method: ``
• Path: ``

Parameters:

• domain: Domain name associated with the hosting account (e.g., example.com) (required)
• archivePath: Absolute or relative path to the website archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding using EXACTLY this naming pattern: directoryname_YYYYMMDD_HHMMSS.zip (e.g., mywebsite_20250115_143022.zip) (required)
• databaseDump: Absolute or relative path to a database dump file (.sql) (required)

hosting_deployWordpressPlugin

Deploy a WordPress plugin from a directory to a hosting server. This tool uploads all plugin files and triggers plugin deployment.

• Method: ``
• Path: ``

Parameters:

• domain: Domain name associated with the hosting account (e.g., example.com) (required)
• slug: WordPress plugin slug (e.g., omnisend) (required)
• pluginPath: Absolute or relative path to the plugin directory containing all plugin files (required)

hosting_deployWordpressTheme

Deploy a WordPress theme from a directory to a hosting server. This tool uploads all theme files and triggers theme deployment. The uploaded theme can optionally be activated after deployment.

• Method: ``
• Path: ``

Parameters:

• domain: Domain name associated with the hosting account (e.g., example.com) (required)
• slug: WordPress theme slug (e.g., twentytwentyfive) (required)
• themePath: Absolute or relative path to the theme directory containing all theme files (required)
• activate: Whether to activate the theme after deployment (default: false)

hosting_deployJsApplication

Deploy a JavaScript application from an archive file to a hosting server. IMPORTANT: the archive must ONLY contain application source files, not the build output, skip node_modules directory; also exclude all files matched by .gitignore if the ignore file exists. The build process will be triggered automatically on the server after the archive is uploaded. After deployment, use the hosting_listJsDeployments tool to check deployment status and track build progress.

• Method: ``
• Path: ``

Parameters:

• domain: Domain name associated with the hosting account (e.g., example.com) (required)
• archivePath: Absolute or relative path to the application archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding. IMPORTANT: the archive must ONLY contain application source files, not the build output, skip node_modules directory. (required)
• removeArchive: Whether to remove the archive file after successful deployment (default: false)

hosting_deployStaticWebsite

Deploy a static website from an archive file to a hosting server. IMPORTANT: This tool only works for static websites with no build process. The archive must contain pre-built static files (HTML, CSS, JavaScript, images, etc.) ready to be served. If the website has a package.json file or requires a build command, use hosting_deployJsApplication instead. The archive will be extracted and deployed directly without any build steps. The username will be automatically resolved from the domain.

• Method: ``
• Path: ``

Parameters:

• domain: Domain name associated with the hosting account (e.g., example.com) (required)
• archivePath: Absolute or relative path to the static website archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding using EXACTLY this naming pattern: directoryname_YYYYMMDD_HHMMSS.zip (e.g., mystaticwebsite_20250115_143022.zip) (required)
• removeArchive: Whether to remove the archive file after successful deployment (default: false)

hosting_listJsDeployments

List javascript application deployments for checking their status. Use this tool when customer asks for the status of the deployment. This tool retrieves a paginated list of Node.js application deployments for a domain with optional filtering by deployment states.

• Method: ``
• Path: ``

Parameters:

• domain: Domain name associated with the hosting account (e.g., example.com) (required)
• page: Page number for pagination (optional)
• perPage: Number of items per page (optional)
• states: Filter by deployment states (optional). Valid values: pending, completed, running, failed

hosting_showJsDeploymentLogs

Retrieve logs for a specified JavaScript application deployment for debugging purposes in case of failure.

• Method: ``
• Path: ``

Parameters:

• domain: Domain name associated with the hosting account (e.g., example.com) (required)
• fromLine: Line from which to retrieve logs (optional, default 0)
• buildUuid: UUID of the JavaScript deployment build (required)

billing_getCatalogItemListV1

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

billing_setDefaultPaymentMethodV1

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)

billing_deletePaymentMethodV1

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)

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.

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

billing_getSubscriptionListV1

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

billing_disableAutoRenewalV1

Disable auto-renewal for a subscription.

Use this endpoint when disable auto-renewal for a subscription.

• Method: DELETE
• Path: /api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/disable

Parameters:

• subscriptionId: Subscription ID (required)

billing_enableAutoRenewalV1

Enable auto-renewal for a subscription.

Use this endpoint when enable auto-renewal for a subscription.

• Method: PATCH
• Path: /api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/enable

Parameters:

• subscriptionId: Subscription ID (required)

DNS_getDNSSnapshotV1

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)

DNS_getDNSSnapshotListV1

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)

DNS_restoreDNSSnapshotV1

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)

DNS_getDNSRecordsV1

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)

DNS_updateDNSRecordsV1

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)

DNS_deleteDNSRecordsV1

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)

DNS_resetDNSRecordsV1

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

DNS_validateDNSRecordsV1

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)

v2_getDomainVerificationsDIRECT

Retrieve a list of pending and completed domain verifications.

• Method: GET
• Path: /api/v2/direct/verifications/active

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 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

domains_getDomainForwardingV1

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)

domains_deleteDomainForwardingV1

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)

domains_createDomainForwardingV1

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)

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.

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

Parameters:

• domain: Domain name (required)

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.

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

Parameters:

• domain: Domain name (required)

domains_getDomainDetailsV1

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)

domains_getDomainListV1

Retrieve all domains associated with your account.

Use this endpoint to view user's domain portfolio.

• Method: GET
• Path: /api/domains/v1/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 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

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.

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

Parameters:

• domain: Domain name (required)

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.

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

Parameters:

• domain: Domain name (required)

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.

• 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

domains_getWHOISProfileV1

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)

domains_deleteWHOISProfileV1

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)

domains_getWHOISProfileListV1

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)

domains_createWHOISProfileV1

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)

domains_getWHOISProfileUsageV1

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)

hosting_listAvailableDatacentersV1

Retrieve a list of datacenters available for setting up hosting plans based on available datacenter capacity and hosting plan of your order. The first item in the list is the best match for your specific order requirements.

• Method: GET
• Path: /api/hosting/v1/datacenters

Parameters:

• order_id: Order ID (required)

hosting_generateAFreeSubdomainV1

Generate a unique free subdomain that can be used for hosting services without purchasing custom domains. Free subdomains allow you to start using hosting services immediately and you can always connect a custom domain to your site later.

• Method: POST
• Path: /api/hosting/v1/domains/free-subdomains

hosting_verifyDomainOwnershipV1

Verify ownership of a single domain and return the verification status.

Use this endpoint to check if a domain is accessible for you before using it for new websites. If the domain is accessible, the response will have is_accessible: true. If not, add the given TXT record to your domain's DNS records and try verifying again. Keep in mind that it may take up to 10 minutes for new TXT DNS records to propagate.

Skip this verification when using Hostinger's free subdomains (*.hostingersite.com).

• Method: POST
• Path: /api/hosting/v1/domains/verify-ownership

Parameters:

• domain: Domain to verify ownership for (required)

hosting_listOrdersV1

Retrieve a paginated list of orders accessible to the authenticated client.

This endpoint returns orders of your hosting accounts as well as orders of other client hosting accounts that have shared access with you.

Use the available query parameters to filter results by order statuses or specific order IDs for more targeted results.

• Method: GET
• Path: /api/hosting/v1/orders

Parameters:

• page: Page number
• per_page: Number of items per page
• statuses: Filter by order statuses
• order_ids: Filter by specific order IDs

hosting_listWebsitesV1

Retrieve a paginated list of websites (main and addon types) accessible to the authenticated client.

This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you.

Use the available query parameters to filter results by username, order ID, enabled status, or domain name for more targeted results.

• Method: GET
• Path: /api/hosting/v1/websites

Parameters:

• page: Page number
• per_page: Number of items per page
• username: Filter by specific username
• order_id: Order ID
• is_enabled: Filter by enabled status
• domain: Filter by domain name (exact match)

hosting_createWebsiteV1

Create a new website for the authenticated client.

Provide the domain name and associated order ID to create a new website. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter.

Subsequent websites will be hosted on the same datacenter automatically.

Website creation takes up to a few minutes to complete. Check the websites list endpoint to see when your new website becomes available.

• Method: POST
• Path: /api/hosting/v1/websites

Parameters:

• domain: Domain name for the website. Cannot start with "www." (required)
• order_id: ID of the associated order (required)
• datacenter_code: Datacenter code. This parameter is required when creating the first website on a new hosting plan.

reach_deleteAContactV1

Delete a contact with the specified UUID.

This endpoint permanently removes a contact from the email marketing system.

• Method: DELETE
• Path: /api/reach/v1/contacts/{uuid}

Parameters:

• uuid: UUID of the contact to delete (required)

reach_listContactGroupsV1

Get a list of all contact groups.

This endpoint returns a list of contact groups that can be used to organize contacts.

• Method: GET
• Path: /api/reach/v1/contacts/groups

reach_listContactsV1

Get a list of contacts, optionally filtered by group and subscription status.

This endpoint returns a paginated list of contacts with their basic information. You can filter contacts by group UUID and subscription status.

• Method: GET
• Path: /api/reach/v1/contacts

Parameters:

• group_uuid: Filter contacts by group UUID
• subscription_status: Filter contacts by subscription status
• page: Page number

reach_createANewContactV1

Create a new contact in the email marketing system.

This endpoint allows you to create a new contact with basic information like name, email, and surname.

If double opt-in is enabled, the contact will be created with a pending status and a confirmation email will be sent.

• Method: POST
• Path: /api/reach/v1/contacts

Parameters:

• email: email parameter (required)
• name: name parameter
• surname: surname parameter
• note: note parameter

reach_listSegmentsV1

Get a list of all contact segments.

This endpoint returns a list of contact segments that can be used to organize contacts.

• Method: GET
• Path: /api/reach/v1/segmentation/segments

reach_createANewContactSegmentV1

Create a new contact segment.

This endpoint allows creating a new contact segment that can be used to organize contacts. The segment can be configured with specific criteria like email, name, subscription status, etc.

• Method: POST
• Path: /api/reach/v1/segmentation/segments

Parameters:

• name: name parameter (required)
• conditions: conditions parameter (required)
• logic: logic parameter (required)

reach_listSegmentContactsV1

Retrieve contacts associated with a specific segment.

This endpoint allows you to fetch and filter contacts that belong to a particular segment, identified by its UUID.

• Method: GET
• Path: /api/reach/v1/segmentation/segments/{segmentUuid}/contacts

Parameters:

• segmentUuid: Segment uuid parameter (required)
• page: Page number
• per_page: Number of items per page

reach_getSegmentDetailsV1

Get details of a specific segment.

This endpoint retrieves information about a single segment identified by UUID. Segments are used to organize and group contacts based on specific criteria.

• Method: GET
• Path: /api/reach/v1/segmentation/segments/{segmentUuid}

Parameters:

• segmentUuid: Segment uuid parameter (required)

reach_createNewContactsV1

Create a new contact in the email marketing system.

This endpoint allows you to create a new contact with basic information like name, email, and surname.

If double opt-in is enabled, the contact will be created with a pending status and a confirmation email will be sent.

• Method: POST
• Path: /api/reach/v1/profiles/{profileUuid}/contacts

Parameters:

• profileUuid: Profile uuid parameter (required)
• email: email parameter (required)
• name: name parameter
• surname: surname parameter
• note: note parameter

reach_listProfilesV1

This endpoint returns all profiles available to the client, including their basic information.

• Method: GET
• Path: /api/reach/v1/profiles

VPS_getDataCenterListV1

Retrieve all available data centers.

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

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

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.

• 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)

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.

• 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)

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.

• 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)

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, file path and list of containers with details about their names, image, status, health and ports. Container stats are omitted in this endpoint. If you need to get detailed information about container with stats included, use the Get project containers endpoint.

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)

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 with the same name already exists, existing project 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)
• environment: Project environment variables

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.

• 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)

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.

• 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)

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.

• 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)

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.

• 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)

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.

• 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)

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.

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

Parameters:

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

VPS_deactivateFirewallV1

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)

VPS_getFirewallDetailsV1

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)

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.

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

Parameters:

• firewallId: Firewall ID (required)

VPS_getFirewallListV1

Retrieve all available firewalls.

Use this endpoint to view existing firewall configurations.

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

Parameters:

• page: Page number

VPS_createNewFirewallV1

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)

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.

• 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)

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.

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

Parameters:

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

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.

• 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)

VPS_syncFirewallV1

Documentation truncated — see the full README on GitHub.