hostinger api mcp

Hostinger API的模型上下文协议（MCP）服务器。

先决条件

Node.js版本24或更高

如果你没有安装Node.js，你可以从官方网站.

我们建议使用 NVM（节点版本管理器）安装和管理已安装的Node.js版本。安装NVM后，您可以使用以下命令安装Node.js：

nvm install v24
nvm use v24

安装

要安装MCP服务器，请根据您的软件包管理器运行以下命令之一：

# 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

更新

要将MCP服务器更新到最新版本，请根据您的包管理器使用以下命令之一：

# 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

配置

运行服务器时可以配置以下环境变量：

DEBUG：启用调试日志记录（true/false）（默认值：false）
API_TOKEN：您的API令牌，将在 Authorization 头球

用法

Claude、Cursor等的JSON配置。

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

运输选项

MCP服务器支持两种传输模式：

标准I/O传输

服务器可以使用标准输入/输出（stdio）传输（默认）。这提供了本地流媒体：

可流式HTTP传输

服务器可以使用HTTP流传输。这提供了通过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

用作MCP工具提供者

此服务器实现了模型上下文协议（MCP），可以与任何兼容MCP的消费者一起使用。

使用HTTP流传输连接到此服务器的示例：

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

可用工具

此MCP服务器提供以下工具：

hosting_import WordPress网站

将WordPress网站从存档文件导入到托管服务器。该工具上传网站存档（zip、tar、tar.gz等）和数据库转储（.sql文件），以部署一个完整的WordPress网站。存档将在服务器上自动提取。注意：对于较大的网站，此过程可能需要一段时间。上传完成后，文件将被提取，网站将在几分钟内可用。用户名将从域中自动解析。

方法: \\
路径: \\

参数:

domain：与托管帐户关联的域名（例如example.com）（必填）
archivePath：网站存档文件的绝对或相对路径。支持的格式：zip、tar、tar.gz、tgz、7z、gz、gzip。如果用户提供了目录路径，请在继续使用以下命名模式之前从中创建存档：directoryname_YYYYMMDD_HHMMSS.zip（例如，mywebsite_20250115_143022.zip）（必填）
databaseDump：数据库转储文件（.sql）的绝对或相对路径（必需）

hosting_deployWordpress插件

将WordPress插件从目录部署到托管服务器。此工具上传所有插件文件并触发插件部署。

方法: \\
路径: \\

参数:

domain：与托管帐户关联的域名（例如example.com）（必填）
slug：WordPress插件slug（例如omnisend）（必填）
pluginPath：包含所有插件文件的插件目录的绝对或相对路径（必需）

主机_部署WordPress主题

将WordPress主题从目录部署到托管服务器。此工具上传所有主题文件并触发主题部署。上传的主题可以在部署后激活。

方法: \\
路径: \\

参数:

domain：与托管帐户关联的域名（例如example.com）（必填）
slug：WordPress主题符（例如，二十五）（必填）
themePath：包含所有主题文件的主题目录的绝对或相对路径（必需）
activate：部署后是否激活主题（默认值：false）

hosting_deployJs应用程序

将JavaScript应用程序从存档文件部署到托管服务器。重要提示：存档必须只包含应用程序源文件，而不是构建输出，跳过node_modules目录；如果忽略文件存在，也排除.gitignore匹配的所有文件。上传存档后，构建过程将在服务器上自动触发。部署后，使用hosting_listJsDeployments工具检查部署状态并跟踪构建进度。

方法: \\
路径: \\

参数:

domain：与托管帐户关联的域名（例如example.com）（必填）
archivePath：应用程序存档文件的绝对或相对路径。支持的格式：zip、tar、tar.gz、tgz、7z、gz、gzip。若用户提供了目录路径，请在继续之前从中创建存档。重要提示：存档必须只包含应用程序源文件，而不是构建输出，跳过node_modules目录。（必填）
removeArchive：部署成功后是否删除存档文件（默认值：false）

hosting_deployStatic网站

将静态网站从存档文件部署到托管服务器。重要提示：此工具仅适用于没有构建过程的静态网站。存档必须包含预构建的静态文件（HTML、CSS、JavaScript、图像等），以便提供服务。如果网站有package.json文件或需要build命令，请使用hosting_deployJsApplication。存档将被提取并直接部署，无需任何构建步骤。用户名将从域中自动解析。

方法: \\
路径: \\

参数:

domain：与托管帐户关联的域名（例如example.com）（必填）
archivePath：静态网站存档文件的绝对或相对路径。支持的格式：zip、tar、tar.gz、tgz、7z、gz、gzip。如果用户提供了目录路径，请在继续使用以下命名模式之前从中创建存档：directoryname_YYYYMMDD_HHMMSS.zip（例如mystaticwebsite_20250115_143022.zip）（必填）
removeArchive：部署成功后是否删除存档文件（默认值：false）

hosting_listJs部署

列出javascript应用程序部署以检查其状态。当客户询问部署状态时，请使用此工具。此工具检索域的Node.js应用程序部署的分页列表，并可选择按部署状态进行筛选。

方法: \\
路径: \\

参数:

domain：与托管帐户关联的域名（例如example.com）（必填）
page：分页页码（可选）
perPage：每页项目数（可选）
states：按部署状态筛选（可选）。有效值：待定、已完成、正在运行、失败

hosting_showJs部署日志

检索指定JavaScript应用程序部署的日志，以便在失败时进行调试。

方法: \\
路径: \\

参数:

domain：与托管帐户关联的域名（例如example.com）（必填）
fromLine：从中检索日志的行（可选，默认为0）
buildUuid：JavaScript部署版本的UUID（必需）

billing_getCatalogItemListV1

检索可供订购的目录项。

目录项中的价格显示为美分（无浮点数），例如：浮点数 17.99 显示为整数 1799.

在下单之前，使用此端点查看可用服务和定价。

方法: GET
路径: /api/billing/v1/catalog

参数:

category：按类别筛选目录项
name：按名称筛选目录项。使用 * 用于通配符搜索，例如。 .COM* 查找.com域名

billing_createServiceOrderV1

创建新的服务订单。

已弃用

要购买域名，请使用 POST /api/domains/v1/portfolio 相反。

要购买VPS，请使用 POST /api/vps/v1/virtual-machines 相反。

要下订单，您需要提供付款方式ID和目录端点中的价格项目列表以及数量。创建订单时也可以提供优惠券。

使用此端点创建的订单将设置为自动续订。

一些 credit_card 付款可能需要额外的验证，导致购买未经处理。我们建议使用其他付款方式，而不是 credit_card 如果你遇到这个问题。

方法: POST
路径: /api/billing/v1/orders

参数:

payment_method_id：付款方式ID（必填）
items：items参数（必填）
coupons：折扣券代码

billing_set默认付款方式V1

为您的帐户设置默认付款方式。

使用此端点配置未来订单的主要付款方式。

方法: POST
路径: /api/billing/v1/payment-methods/{paymentMethodId}

参数:

paymentMethodId：付款方式ID（必填）

账单_付款方式V1

从您的帐户中删除付款方式。

使用此终结点从用户帐户中删除未使用的付款方式。

方法: DELETE
路径: /api/billing/v1/payment-methods/{paymentMethodId}

参数:

paymentMethodId：付款方式ID（必填）

billing_getPayment方法列表V1

检索可用于下新订单的可用付款方式。

如果您想添加新的付款方式，请使用 h面板.

在创建订单之前，使用此端点查看可用的付款选项。

方法: GET
路径: /api/billing/v1/payment-methods

billing_cancel订阅V1

取消订阅并停止任何进一步的计费。

当用户想要终止活动服务时，请使用此终结点。

方法: DELETE
路径: /api/billing/v1/subscriptions/{subscriptionId}

参数:

subscriptionId：订阅ID（必填）

billing_get订阅列表V1

检索与您的帐户关联的所有订阅的列表。

使用此端点监视活动服务和计费状态。

方法: GET
路径: /api/billing/v1/subscriptions

比林斯

禁用订阅的自动续订。

禁用订阅的自动续订时使用此终结点。

方法: DELETE
路径: /api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/disable

参数:

subscriptionId：订阅ID（必填）

billing_enable自动续订V1

启用订阅的自动续订。

启用订阅的自动续订时使用此终结点。

方法: PATCH
路径: /api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/enable

参数:

subscriptionId：订阅ID（必填）

DNS_getDNSSnapshotV1

检索包含DNS区域记录内容的特定DNS快照。

使用此端点查看域的历史DNS配置。

方法: GET
路径: /api/dns/v1/snapshots/{domain}/{snapshotId}

参数:

domain：域名（必填）
snapshotId：快照ID（必需）

DNS_getDNS快照列表V1

检索域的DNS快照。

使用此终结点查看可用的DNS备份点以进行还原。

方法: GET
路径: /api/dns/v1/snapshots/{domain}

参数:

domain：域名（必填）

DNS_restoreDNSSnapshotV1

将DNS区域还原到所选快照。

使用此终结点将域DNS还原为以前的配置。

方法: POST
路径: /api/dns/v1/snapshots/{domain}/{snapshotId}/restore

参数:

domain：域名（必填）
snapshotId：快照ID（必需）

DNS_getDNS记录V1

检索特定域的DNS区域记录。

使用此终结点查看域管理的当前DNS配置。

方法: GET
路径: /api/dns/v1/zones/{domain}

参数:

domain：域名（必填）

DNS_更新DNS记录V1

更新所选域的DNS记录。

使用 overwrite = true 将用提供的记录替换现有记录。否则，将更新现有记录并添加新记录。

使用此终结点修改域DNS配置。

方法: PUT
路径: /api/dns/v1/zones/{domain}

参数:

domain：域名（必填）
overwrite：如果 true，将删除与名称和类型匹配的资源记录（RR），并创建新的RR，否则将更新资源记录的ttl并附加新记录。如果没有找到匹配的RR，则创建它们。
zone：区域参数（必填）

DNS_deleteDNS记录V1

删除所选域的DNS记录。

要筛选要删除的记录，请添加 name 记录和 type 到过滤器。单个请求可以提供多个过滤器。

如果您有多个同名和同类型的记录，并且只想删除其中的一部分，参考 Update zone records 终点。

使用此终结点从域中删除特定的DNS记录。

方法: DELETE
路径: /api/dns/v1/zones/{domain}

参数:

domain：域名（必填）

DNS_resetDNS记录V1

将DNS区域重置为默认记录。

使用此终结点将域DNS还原为原始配置。

方法: POST
路径: /api/dns/v1/zones/{domain}/reset

参数:

domain：域名（必填）
sync：确定操作是否应同步运行
reset_email_records：确定是否应重置电子邮件记录
whitelisted_record_types：指定不重置哪些记录类型

DNS_验证DNS记录V1

在更新所选域之前验证DNS记录。

如果验证成功，响应将包含 200 Success 代码。如果存在验证错误，响应将失败 422 Validation error 代码。

在应用更改之前，使用此终结点验证DNS记录的有效性。

方法: POST
路径: /api/dns/v1/zones/{domain}/validate

参数:

domain：域名（必填）
overwrite：如果 true，将删除与名称和类型匹配的资源记录（RR），并创建新的RR，否则将更新资源记录的ttl并附加新记录。如果没有找到匹配的RR，则创建它们。
zone：区域参数（必填）

v2_getDomainVerificationsDIRECT

检索待处理和已完成的域验证列表。

方法: GET
路径: /api/v2/direct/verifications/active

域名_检查域名可用性V1

检查多个TLD中域名的可用性。

可以同时检查多个TLD。如果您想要有响应的替代域名，请只提供一个TLD并设置 with_alternatives 到 true. TLD应不带前导点（例如。 com, net, org).

终结点的速率限制为每分钟10个请求。

购买前使用此端点验证域可用性。

方法: POST
路径: /api/domains/v1/availability

参数:

domain：域名（不含TLD）（必填）
tlds：TLD列表（必填）
with_alternatives：回应是否应包括替代方案

域名_域名转发V1

检索域转发数据。

使用此端点查看域的当前重定向配置。

方法: GET
路径: /api/domains/v1/forwarding/{domain}

参数:

domain：域名（必填）

域名_删除域名转发V1

删除域转发数据。

使用此终结点从域中删除重定向配置。

方法: DELETE
路径: /api/domains/v1/forwarding/{domain}

参数:

domain：域名（必填）

域名_创建域名转发V1

创建域转发配置。

使用此端点设置指向其他URL的域重定向。

方法: POST
路径: /api/domains/v1/forwarding

参数:

domain：域名（必填）
redirect_type：重定向类型（必需）
redirect_url：将域转发到的URL（必需）

domains_enableDomainLockV1

为域启用域锁定。

启用域锁定后，如果不首先禁用锁定，则无法将域转移到另一个注册商。

使用此端点保护域免受未经授权的传输。

方法: PUT
路径: /api/domains/v1/portfolio/{domain}/domain-lock

参数:

domain：域名（必填）

domains_diable域名锁V1

禁用域的域锁定。

在将域转移到另一个注册商之前，需要禁用域锁。

使用此端点准备域以转移到其他注册商。

方法: DELETE
路径: /api/domains/v1/portfolio/{domain}/domain-lock

参数:

domain：域名（必填）

域名_域名详情V1

检索指定域的详细信息。

使用此端点查看全面的域配置和状态。

方法: GET
路径: /api/domains/v1/portfolio/{domain}

参数:

domain：域名（必填）

域名_getDomainListV1

检索与您的帐户关联的所有域。

使用此端点查看用户的域组合。

方法: GET
路径: /api/domains/v1/portfolio

域名_购买新域名V1

购买并注册新域名。

如果注册失败，请登录 h面板并检查域注册状态。

如果没有提供付款方式，将自动使用默认付款方式。

如果没有提供WHOIS信息，将使用该TLD的默认联系信息。在提出请求之前，请确保您的帐户中存在所需TLD的WHOIS信息。

某些TLD要求 additional_details 这些将在完成购买之前进行验证。

使用此端点为用户注册新域。

方法: POST
路径: /api/domains/v1/portfolio

参数:

domain：域名（必填）
item_id：目录价格项目ID（必填）
payment_method_id：付款方式ID，如果未提供，将使用默认值
domain_contacts：域联系信息
additional_details：其他注册数据，可能的值取决于TLD
coupons：折扣券代码

域名启用隐私保护V1

为域启用隐私保护。

启用隐私保护后，域所有者的个人信息将从公共WHOIS数据库中隐藏。

使用此端点保护域所有者的个人信息不被公众看到。

方法: PUT
路径: /api/domains/v1/portfolio/{domain}/privacy-protection

参数:

domain：域名（必填）

域名_隐私保护V1

禁用域的隐私保护。

当隐私保护被禁用时，域所有者的个人信息在公共WHOIS数据库中可见。

使用此端点使域所有者的信息公开可见。

方法: DELETE
路径: /api/domains/v1/portfolio/{domain}/privacy-protection

参数:

domain：域名（必填）

域名更新域名服务器V1

为指定域设置名称服务器。

请注意，不正确的名称服务器配置可能会导致域无法解析或不可用。

使用此终结点为域配置自定义DNS宿主。

方法: PUT
路径: /api/domains/v1/portfolio/{domain}/nameservers

参数:

domain：域名（必填）
ns1：名字服务器（必填）
ns2：第二个名称服务器（必需）
ns3：第三名称服务器
ns4：第四个名称服务器

域名_getWHOIProfile V1

检索WHOIS联系人资料。

使用此端点查看域注册联系人信息。

方法: GET
路径: /api/domains/v1/whois/{whoisId}

参数:

whoisId：WHOIS ID（必填）

域名_deleteWOISProfileV1

删除WHOIS联系人资料。

使用此终结点从帐户中删除未使用的联系人配置文件。

方法: DELETE
路径: /api/domains/v1/whois/{whoisId}

参数:

whoisId：WHOIS ID（必填）

域名_getWHOIProfile列表V1

检索WHOIS联系人资料。

使用此端点查看域注册的可用联系人配置文件。

方法: GET
路径: /api/domains/v1/whois

参数:

tld：按TLD筛选（不带前导点）

域名_创建WHOIProfile V1

创建WHOIS联系人资料。

使用此端点为域注册添加新的联系人信息。

方法: POST
路径: /api/domains/v1/whois

参数:

tld：域名的顶级域名（不带前导点）（必填）
country：ISO 3166 2个字母的国家代码（必填）
entity_type：法人实体类型（必填）
tld_details：TLD详细信息
whois_details：WHOIS详细信息（必填）

域名_getWHOIProfile使用情况V1

检索使用WHOIS联系人配置文件的域列表。

使用此端点可以查看哪些域使用特定的联系人配置文件。

方法: GET
路径: /api/domains/v1/whois/{whoisId}/usage

参数:

whoisId：WHOIS ID（必填）

主机列表可用数据中心V1

根据可用数据中心容量和您订单的托管计划，检索可用于设置托管计划的数据中心列表。列表中的第一项最符合您的特定订单要求。

方法: GET
路径: /api/hosting/v1/datacenters

参数:

order_id：订单ID（必填）

hosting_generateFreeSubdomainV1

生成一个唯一的免费子域，可用于托管服务，而无需购买自定义域。免费的子域允许您立即开始使用托管服务，并且您以后可以随时将自定义域连接到您的网站。

方法: POST
路径: /api/hosting/v1/domains/free-subdomains

主机_验证域名所有者V1

验证单个域的所有权并返回验证状态。

在将域用于新网站之前，使用此端点检查域是否可供您访问。如果域可访问，则响应将具有 is_accessible: true. 如果没有，请将给定的TXT记录添加到域的DNS记录中，然后再次尝试验证。请记住，传播新的TXT DNS记录可能需要长达10分钟的时间。

使用Hostinger的免费子域（\*.hostingersite.com）时跳过此验证。

方法: POST
路径: /api/hosting/v1/domains/verify-ownership

参数:

domain：要验证所有权的域（必需）

hosting_listOrdersV1

检索经过身份验证的客户端可访问的订单分页列表。

此端点返回您的托管帐户订单以及与您共享访问权限的其他客户端托管帐户的订单。

使用可用的查询参数按订单状态或特定订单ID筛选结果，以获得更有针对性的结果。

方法: GET
路径: /api/hosting/v1/orders

参数:

page：页码
per_page：每页项目数
statuses：按订单状态筛选
order_ids：按特定订单ID筛选

hosting_listWebsitesV1

检索经过身份验证的客户端可访问的网站（主网站和插件类型）的分页列表。

此终结点返回来自您的托管帐户的网站以及来自与您共享访问权限的其他客户端托管帐户的网页。

使用可用的查询参数按用户名、订单ID、启用状态或域名筛选结果，以获得更有针对性的结果。

方法: GET
路径: /api/hosting/v1/websites

参数:

page：页码
per_page：每页项目数
username：按特定用户名筛选
order_id：订单ID
is_enabled：按启用状态筛选
domain：按域名筛选（完全匹配）

hosting_createWebsiteV1

为经过身份验证的客户端创建新网站。

提供域名和相关订单ID以创建新网站。在新的托管计划上创建第一个网站时，需要datacer_code参数，这将在所选数据中心设置和配置新的托管帐户。

后续网站将自动托管在同一数据中心。

网站创建需要几分钟才能完成。检查网站列表端点，查看新网站何时可用。

方法: POST
路径: /api/hosting/v1/websites

参数:

domain：网站的域名。不能以“www.”开头（必填）
order_id：关联订单的ID（必填）
datacenter_code：数据中心代码。在新的托管计划上创建第一个网站时，此参数是必需的。

reach_deleteAContactV1

删除具有指定UUID的联系人。

此端点将从电子邮件营销系统中永久删除联系人。

方法: DELETE
路径: /api/reach/v1/contacts/{uuid}

参数:

uuid：要删除的联系人的UUID（必需）

reach_list联系人组V1

获取所有联系人组的列表。

此终结点返回可用于组织联系人的联系人组列表。

方法: GET
路径: /api/reach/v1/contacts/groups

reach_list联系人V1

获取联系人列表，可选择按组和订阅状态进行筛选。

此端点返回一个分页的联系人列表及其基本信息。您可以按组UUID和订阅状态筛选联系人。

方法: GET
路径: /api/reach/v1/contacts

参数:

group_uuid：按组UUID筛选联系人
subscription_status：按订阅状态筛选联系人
page：页码

reach_createANewContactV1

在电子邮件营销系统中创建新联系人。

此端点允许您使用姓名、电子邮件和姓氏等基本信息创建新联系人。您可以选择将联系人分配到特定组并添加注释。

联系人将自动订阅电子邮件通信。

方法: POST
路径: /api/reach/v1/contacts

参数:

email：电子邮件参数（必填）
name：name参数
surname：姓氏参数
note：注释参数

reach_filterSegments ContactsV1

根据细分标准过滤和检索联系人。

此端点允许使用指定条件筛选联系人，并返回匹配联系人的分页列表。可以使用电子邮件、姓名、订阅状态等各种属性过滤结果。

方法: POST
路径: /api/reach/v1/segmentation/filters/contacts

参数:

conditions：条件参数（必填）
logic：逻辑参数（必填）
page：页面参数
per_page：per_page参数

reach_list联系人分段V1

获取所有联系人段的列表。

此端点返回可用于组织联系人的联系人段列表。

方法: GET
路径: /api/reach/v1/segmentation/segments

reach_createANewContactSegmentV1

创建新的联系人段。

此端点允许创建可用于组织联系人的新联系人段。该段可以配置特定的条件，如电子邮件、姓名、订阅状态等。

方法: POST
路径: /api/reach/v1/segmentation/segments

参数:

name：name参数（必需）
conditions：条件参数（必填）
logic：逻辑参数（必填）

reach_getSegmentDetails V1

获取特定细分市场的详细信息。

此端点检索由UUID标识的单个段的信息。分段用于根据特定标准组织和分组联系人。

方法: GET
路径: /api/reach/v1/segmentation/segments/{segmentUuid}

参数:

segmentUuid：段uuid参数（必需）

VPS_getDataCenterListV1

检索所有可用的数据中心。

在部署VPS实例之前，使用此端点查看位置选项。

方法: GET
路径: /api/vps/v1/data-centers

VPS_getProjectContainersV1

检索属于虚拟机上特定Docker Compose项目的所有容器的列表。

此端点返回有关每个容器的详细信息，包括其当前状态、端口映射和运行时配置。

使用此功能可监控Docker Compose项目中所有服务的运行状况和状态。

方法: GET
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/containers

参数:

virtualMachineId：虚拟机ID（必需）
projectName：Docker仅使用字母数字字符、破折号和下划线编写项目名称（必需）

VPS_getProjectContentsV1

检索完整的项目信息，包括docker-compose.yml文件内容、项目元数据和当前部署状态。

此端点提供特定Docker Compose项目的完整配置和状态详细信息。

使用此选项可以检查项目设置、查看撰写文件或检查整体项目运行状况。

方法: GET
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}

参数:

virtualMachineId：虚拟机ID（必需）
projectName：Docker仅使用字母数字字符、破折号和下划线编写项目名称（必需）

VPS_deleteProjectV1

从虚拟机中完全删除Docker Compose项目，停止所有容器并清理相关资源，包括网络、卷和图像。

此操作是不可逆的，将删除所有项目数据。

当您想永久删除项目并释放系统资源时，请使用此选项。

方法: DELETE
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/down

参数:

virtualMachineId：虚拟机ID（必需）
projectName：Docker仅使用字母数字字符、破折号和下划线编写项目名称（必需）

VPS_getProjectListV1

检索当前部署在虚拟机上的所有Docker Compose项目的列表。

此端点返回每个项目的基本信息，包括名称、状态、文件路径和容器列表关于他们的姓名、形象、状态、健康状况和端口的详细信息。此端点中省略了容器统计信息。如果您需要获取包含统计信息的容器的详细信息，请使用 Get project containers 终点。

使用此功能可以概述您的VPS实例上的所有Docker项目。

方法: GET
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/docker

参数:

virtualMachineId：虚拟机ID（必需）

VPS_createNewProjectV1

从docker-compose.yaml内容部署新项目或从URL下载内容。

URL可以是格式为的Github存储库URLhttps://github.com/\[user\]/\[repo\]，它将自动解析为主分支中的docker-compose.yaml文件。提供的任何其他URL都必须返回docker-compose.yaml文件内容。

如果同名项目已存在，则将替换现有项目。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/docker

参数:

virtualMachineId：虚拟机ID（必需）
project_name：Docker仅使用字母数字字符、破折号和下划线编写项目名称（必需）
content：指向docker-compose.yaml文件、Github存储库或compose文件的原始yaml内容的URL（必填）
environment：项目环境变量

VPS_getProjectLogsV1

从Docker Compose项目中的所有服务检索聚合日志条目。

此端点返回每个容器的最新日志输出，按服务名称和时间戳组织。响应包含所有服务的最后300个日志条目。

使用此功能可调试、监视应用程序行为，并排除整个项目堆栈中的问题。

方法: GET
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/logs

参数:

virtualMachineId：虚拟机ID（必需）
projectName：Docker仅使用字母数字字符、破折号和下划线编写项目名称（必需）

VPS_startProjectV1

通过以正确的依赖顺序停止和启动容器来重新启动Docker Compose项目中的所有服务。

此操作在刷新正在运行的容器时保留数据卷和网络配置。

使用此选项可应用配置更改或从服务故障中恢复。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/restart

参数:

virtualMachineId：虚拟机ID（必需）
projectName：Docker仅使用字母数字字符、破折号和下划线编写项目名称（必需）

VPS_startProjectV1

启动Docker Compose项目中当前已停止的所有服务。

此操作将按照组合文件中定义的正确依赖顺序打开容器。

使用此选项可恢复以前停止的项目，或在系统重新启动后启动服务。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/start

参数:

virtualMachineId：虚拟机ID（必需）
projectName：Docker仅使用字母数字字符、破折号和下划线编写项目名称（必需）

VPS_topProjectV1

停止Docker Compose项目中所有正在运行的服务，同时保留容器配置和数据卷。

此操作以相反的依赖顺序优雅地关闭容器。

使用此选项可在不删除数据或配置的情况下临时停止项目。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/stop

参数:

virtualMachineId：虚拟机ID（必需）
projectName：Docker仅使用字母数字字符、破折号和下划线编写项目名称（必需）

VPS_updateProjectV1

通过拉取最新映像版本并使用新配置重新创建容器来更新Docker Compose项目。

此操作在应用组合文件中的更改时保留数据卷。

使用此选项部署应用程序更新、应用配置更改或将容器映像刷新到其最新版本。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/update

参数:

virtualMachineId：虚拟机ID（必需）
projectName：Docker仅使用字母数字字符、破折号和下划线编写项目名称（必需）

VPS_activate防火墙V1

为指定的虚拟机激活防火墙。

一次只能有一个防火墙对虚拟机处于活动状态。

使用此端点将防火墙规则应用于VPS实例。

方法: POST
路径: /api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}

参数:

firewallId：防火墙ID（必需）
virtualMachineId：虚拟机ID（必需）

VPS_deactivate防火墙V1

停用指定虚拟机的防火墙。

使用此端点从VPS实例中删除防火墙保护。

方法: POST
路径: /api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}

参数:

firewallId：防火墙ID（必需）
virtualMachineId：虚拟机ID（必需）

VPS_getFirewall详细信息V1

通过防火墙的ID和与之关联的规则检索防火墙。

使用此端点查看特定的防火墙配置和规则。

方法: GET
路径: /api/vps/v1/firewall/{firewallId}

参数:

firewallId：防火墙ID（必需）

VPS_delete防火墙V1

删除指定的防火墙。

任何已激活此防火墙的虚拟机都将自动将其停用。

使用此端点删除未使用的防火墙配置。

方法: DELETE
路径: /api/vps/v1/firewall/{firewallId}

参数:

firewallId：防火墙ID（必需）

VPS_getFirewallListV1

检索所有可用的防火墙。

使用此端点查看现有防火墙配置。

方法: GET
路径: /api/vps/v1/firewall

参数:

page：页码

VPS_createNewFirewallV1

创建新防火墙。

使用此端点为VPS安全设置新的防火墙配置。

方法: POST
路径: /api/vps/v1/firewall

参数:

name：name参数（必需）

VPS_update防火墙规则V1

从指定的防火墙更新特定的防火墙规则。

任何激活了此防火墙的虚拟机都将与防火墙失去同步，必须手动再次同步。

使用此端点修改现有防火墙规则。

方法: PUT
路径: /api/vps/v1/firewall/{firewallId}/rules/{ruleId}

参数:

firewallId：防火墙ID（必需）
ruleId：防火墙规则ID（必需）
protocol：协议参数（必填）
port：端口或端口范围，例如：1024:2048（必填）
source：源参数（必需）
source_detail：IP范围、CIDR、单IP或 any （必填）

VPS_delete防火墙规则V1

从指定的防火墙中删除特定的防火墙规则。

任何激活了此防火墙的虚拟机都将与防火墙失去同步，必须手动再次同步。

使用此端点删除特定的防火墙规则。

方法: DELETE
路径: /api/vps/v1/firewall/{firewallId}/rules/{ruleId}

参数:

firewallId：防火墙ID（必需）
ruleId：防火墙规则ID（必需）

VPS_create防火墙规则V1

为指定的防火墙创建新的防火墙规则。

默认情况下，防火墙会丢弃所有传入流量，这意味着您必须为要使用的所有端口添加接受规则。

任何激活了此防火墙的虚拟机都将与防火墙失去同步，必须手动再次同步。

使用此端点向防火墙添加新的安全规则。

方法: POST
路径: /api/vps/v1/firewall/{firewallId}/rules

参数:

firewallId：防火墙ID（必需）
protocol：协议参数（必填）
port：端口或端口范围，例如：1024:2048（必填）
source：源参数（必需）
source_detail：IP范围、CIDR、单IP或 any （必填）

VPS_syncFirewallV1

为指定的虚拟机同步防火墙。

如果防火墙添加、删除或更新了新规则，则防火墙可能会与虚拟机失去同步。

使用此端点将更新的防火墙规则应用于VPS实例。

方法: POST
路径: /api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}

参数:

firewallId：防火墙ID（必需）
virtualMachineId：虚拟机ID（必需）

VPS_getPostInstallScriptV1

通过ID检索安装后脚本。

使用此端点查看特定的自动化脚本详细信息。

方法: GET
路径: /api/vps/v1/post-install-scripts/{postInstallScriptId}

参数:

postInstallScriptId：安装后脚本ID（必需）

VPS_updatePostInstallScriptV1

更新特定的安装后脚本。

使用此端点修改现有的自动化脚本。

方法: PUT
路径: /api/vps/v1/post-install-scripts/{postInstallScriptId}

参数:

postInstallScriptId：安装后脚本ID（必需）
name：脚本名称（必填）
content：脚本内容（必填）

VPS_deletePostInstallScriptV1

从您的帐户中删除安装后脚本。

使用此端点删除未使用的自动化脚本。

方法: DELETE
路径: /api/vps/v1/post-install-scripts/{postInstallScriptId}

参数:

postInstallScriptId：安装后脚本ID（必需）

VPS_getPostInstallScriptsV1

检索与您的帐户关联的安装后脚本。

使用此端点查看VPS部署的可用自动化脚本。

方法: GET
路径: /api/vps/v1/post-install-scripts

参数:

page：页码

VPS_createPostInstallScriptV1

将新的安装后脚本添加到您的帐户中，然后可以在虚拟机安装后使用。

脚本内容将保存到文件中 /post_install 已设置可执行属性，并将在安装虚拟机后执行。脚本的输出将被重定向到 /post_install.log。最大脚本大小为48KB。

使用此端点为VPS设置任务创建自动化脚本。

方法: POST
路径: /api/vps/v1/post-install-scripts

参数:

name：脚本名称（必填）
content：脚本内容（必填）

VPS_attachPublicKeyV1

将帐户中的现有公钥附加到指定的虚拟机。

多个密钥可以附加到单个虚拟机。

使用此端点为VPS实例启用SSH密钥身份验证。

方法: POST
路径: /api/vps/v1/public-keys/attach/{virtualMachineId}

参数:

virtualMachineId：虚拟机ID（必需）
ids：要附加的公钥ID（必需）

VPS_deletePublic KeyV1

从您的帐户中删除公钥。

从帐户中删除公钥不会将其从虚拟机中删除

使用此端点从帐户中删除未使用的SSH密钥。

方法: DELETE
路径: /api/vps/v1/public-keys/{publicKeyId}

参数:

publicKeyId：公钥ID（必填）

VPS_getPublicKeysV1

检索与您的帐户关联的公钥。

使用此端点查看用于VPS身份验证的可用SSH密钥。

方法: GET
路径: /api/vps/v1/public-keys

参数:

page：页码

VPS_createPublicKeyV1

为您的帐户添加新的公钥。

使用此端点注册用于VPS身份验证的SSH密钥。

方法: POST
路径: /api/vps/v1/public-keys

参数:

name：name参数（必需）
key：关键参数（必填）

VPS_getTemplateDetails V1

检索有关虚拟机特定操作系统模板的详细信息。

在部署之前，使用此端点查看特定的模板规范。

方法: GET
路径: /api/vps/v1/templates/{templateId}

参数:

templateId：模板ID（必填）

VPS_getTemplatesV1

检索虚拟机的可用操作系统模板。

在创建或重新创建VPS实例之前，使用此端点查看操作系统选项。

方法: GET
路径: /api/vps/v1/templates

VPS_getActionDetails V1

检索有关在指定虚拟机上执行的特定操作的详细信息。

使用此端点监视特定的VPS运行状态和详细信息。

方法: GET
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}

参数:

virtualMachineId：虚拟机ID（必需）
actionId：动作ID（必填）

VPS_getActionsV1

检索在指定虚拟机上执行的操作。

操作是在虚拟机上执行的操作或事件，如启动、停止或修改机器。此端点允许您查看这些操作的历史记录，提供有关每个操作的详细信息，例如动作名称、时间戳和状态。

使用此端点查看VPS操作历史记录并排除问题。

方法: GET
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/actions

参数:

virtualMachineId：虚拟机ID（必需）
page：页码

VPS_getAttached公钥V1

检索附加到指定虚拟机的公钥。

使用此端点查看为特定VPS实例配置的SSH密钥。

方法: GET
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/public-keys

参数:

virtualMachineId：虚拟机ID（必需）
page：页码

VPS_getBackupsV1

检索指定虚拟机的备份。

使用此端点查看VPS数据恢复的可用备份点。

方法: GET
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/backups

参数:

virtualMachineId：虚拟机ID（必需）
page：页码

VPS_storeBackupV1

为指定的虚拟机还原备份。

然后，系统将启动还原过程，这可能需要一些时间，具体取决于备份的大小。

虚拟机上的所有数据都将被备份中的数据覆盖。

使用此端点从备份点恢复VPS数据。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore

参数:

virtualMachineId：虚拟机ID（必需）
backupId：备份ID（必需）

VPS_set主机名V1

为指定的虚拟机设置主机名。

更改主机名不会自动更新PTR记录。如果你希望你的虚拟机可以通过主机名访问，您还需要将域A/AAAA记录指向虚拟机IP。

使用此端点为VPS实例配置自定义主机名。

方法: PUT
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/hostname

参数:

virtualMachineId：虚拟机ID（必需）
hostname：主机名参数（必需）

VPS_reset主机名V1

将指定虚拟机的主机名和PTR记录重置为默认值。

使用此端点还原VPS实例的默认主机名配置。

方法: DELETE
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/hostname

参数:

virtualMachineId：虚拟机ID（必需）

VPS_getVirtualMachine详细信息V1

检索指定虚拟机的详细信息。

使用此端点查看全面的VPS配置和状态。

方法: GET
路径: /api/vps/v1/virtual-machines/{virtualMachineId}

参数:

virtualMachineId：虚拟机ID（必需）

VPS_getVirtualMachinesV1

检索所有可用的虚拟机。

使用此端点查看可用的VPS实例。

方法: GET
路径: /api/vps/v1/virtual-machines

VPS_purchaseNewVirtualMachineV1

购买并设置新的虚拟机。

如果虚拟机设置因任何原因失败，请登录 h面板并手动完成设置。

如果没有提供付款方式，将自动使用默认付款方式。

使用此端点创建新的VPS实例。

方法: POST
路径: /api/vps/v1/virtual-machines

参数:

item_id：目录价格项目ID（必填）
payment_method_id：付款方式ID，如果未提供，将使用默认值
setup：设置参数（必需）
coupons：折扣券代码

VPS_getScanMetricsV1

检索的扫描度量 Monarx 安装在指定虚拟机上的恶意软件扫描程序。

扫描度量提供了关于Monarx执行的恶意软件扫描的详细信息，检测到的威胁和其他相关统计数据。此信息可用于监视的安全状态虚拟机和评估恶意软件扫描程序的有效性。

使用此端点监视VPS安全扫描结果和威胁检测。

方法: GET
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/monarx

参数:

virtualMachineId：虚拟机ID（必需）

VPS_installMonarxV1

在指定的虚拟机上安装Monarx恶意软件扫描程序。

Monarx 是一种安全工具，旨在检测和防止虚拟机上的恶意软件感染。通过安装Monarx，用户可以增强其虚拟机的安全性，确保其免受恶意软件的攻击。

使用此端点在VPS实例上启用恶意软件防护。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/monarx

参数:

virtualMachineId：虚拟机ID（必需）

VPS_uninstallMonarxV1

在指定的虚拟机上卸载Monarx恶意软件扫描程序。

如果未安装Monarx，请求仍将被处理，不会产生任何影响。

使用此端点从VPS实例中删除恶意软件扫描程序。

方法: DELETE
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/monarx

参数:

virtualMachineId：虚拟机ID（必需）

VPS_getMetricsV1

检索指定虚拟机的历史指标。

它包括以下指标：

CPU 使用率
内存使用
磁盘使用情况
网络使用
运行时间

使用此端点可随时间监控VPS性能和资源利用率。

方法: GET
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/metrics

参数:

virtualMachineId：虚拟机ID（必需）
date_from：date_from参数（必需）
date_to：date_to参数（必填）

VPS_setNameserversV1

为指定的虚拟机设置名称服务器。

请注意，不正确的名称服务器配置可能会导致虚拟机无法解析域名。

使用此端点为VPS实例配置自定义DNS解析器。

方法: PUT
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/nameservers

参数:

virtualMachineId：虚拟机ID（必需）
ns1：ns1参数（必需）
ns2：ns2参数
ns3：ns3参数

VPS_createPTRRecordV1

为指定的虚拟机创建或更新PTR（指针）记录。

使用此端点为VPS IP地址配置反向DNS查找。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}

参数:

virtualMachineId：虚拟机ID（必需）
ipAddressId：IP地址ID（必填）
domain：指针记录域（必需）

VPS_deletePTRecordV1

删除指定虚拟机的PTR（指针）记录。

一旦删除，对虚拟机IP地址的反向DNS查找将不再返回之前配置的主机名。

使用此端点从VPS实例中删除反向DNS配置。

方法: DELETE
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}

参数:

virtualMachineId：虚拟机ID（必需）
ipAddressId：IP地址ID（必填）

VPS_setPanelPasswordV1

为指定的虚拟机设置面板密码。

如果虚拟机不使用面板操作系统，则请求仍将被处理而不会产生任何影响。密码要求与重新创建虚拟机端点.

使用此端点为VPS实例配置控制面板访问凭据。

方法: PUT
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/panel-password

参数:

virtualMachineId：虚拟机ID（必需）
password：虚拟机的面板密码（必需）

VPS_startRecoveryModeV1

为指定的虚拟机启动恢复模式。

恢复模式是允许用户执行系统救援操作的特殊状态，例如修复文件系统、恢复数据或排除阻止虚拟机的问题从正常启动。

虚拟机将启动恢复磁盘映像，并将原始磁盘映像装入 /mnt 目录。

使用此端点在VPS实例上启用系统救援操作。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/recovery

参数:

virtualMachineId：虚拟机ID（必需）
root_password：恢复模式的临时根密码（必需）

VPS_topRecoveryModeV1

停止指定虚拟机的恢复模式。

如果虚拟机未处于恢复模式，则此操作将失败。

使用此端点退出系统救援模式并使VPS恢复正常运行。

方法: DELETE
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/recovery

参数:

virtualMachineId：虚拟机ID（必需）

VPS_createVirtualMachineV1

从头开始重新创建虚拟机。

重建过程涉及重新安装操作系统并将虚拟机重置为其初始状态。快照（如果有的话）将被删除。

密码要求

将根据泄露的密码数据库检查密码。密码要求如下：

长度至少为12个字符
至少一个大写字母
至少一个小写字母
至少一个数字
未公开泄露

此操作是不可逆的，将导致存储在虚拟机上的所有数据丢失！

使用此端点可以使用新的操作系统安装完全重建VPS实例。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/recreate

参数:

virtualMachineId：虚拟机ID（必需）
template_id：模板ID（必填）
password：虚拟机的根密码。如果没有提供，将生成随机密码。密码不会显示在响应中。
panel_password：基于面板的操作系统模板的面板密码。如果没有提供，将生成随机密码。如果操作系统不支持panel_password，则此字段将被忽略。密码不会显示在响应中。
post_install_script_id：重新创建虚拟机后执行的安装后脚本

VPS_startVirtualMachineV1

通过完全停止和启动指定的虚拟机来重新启动它。

如果虚拟机已停止，它将启动。

使用此端点重新启动VPS实例。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/restart

参数:

virtualMachineId：虚拟机ID（必需）

VPS_setRootPassword V1

为指定的虚拟机设置根密码。

密码要求与重新创建虚拟机端点.

使用此端点更新VPS实例的管理员凭据。

方法: PUT
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/root-password

参数:

virtualMachineId：虚拟机ID（必需）
password：虚拟机的根密码（必需）

VPS_setup已购买虚拟机V1

使用安装新购买的虚拟机 initial 国家。

使用此端点配置和初始化购买的VPS实例。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/setup

参数:

virtualMachineId：虚拟机ID（必需）
template_id：模板ID（必填）
data_center_id：数据中心ID（必填）
post_install_script_id：安装后脚本ID
password：虚拟机的密码。如果没有提供，将生成随机密码。密码不会显示在响应中。
hostname：覆盖虚拟机的默认主机名
install_monarx：安装Monarx恶意软件扫描程序（如果支持）
enable_backups：启用每周备份计划
ns1：名称服务器1
ns2：名称服务器2
public_key：使用SSH密钥

VPS_getSnapshotV1

检索指定虚拟机的快照。

使用此端点查看当前VPS快照信息。

方法: GET
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot

参数:

virtualMachineId：虚拟机ID（必需）

VPS_createSnapshotV1

创建指定虚拟机的快照。

快照捕获虚拟机在特定时间点的状态和数据，允许用户在需要时将虚拟机恢复到该状态。此操作可用于备份目的、系统恢复、数据传输和数据传输，以及在不影响虚拟机当前状态的情况下测试更改。

创建新快照将覆盖现有快照！

使用此端点捕获VPS状态以进行备份和恢复。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot

参数:

virtualMachineId：虚拟机ID（必需）

VPS_deleteSnapshotV1

删除指定虚拟机的快照。

使用此端点删除VPS快照。

方法: DELETE
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot

参数:

virtualMachineId：虚拟机ID（必需）

VPS_storeSnapshotV1

使用快照将指定的虚拟机还原到以前的状态。

从快照还原允许用户将虚拟机还原到该状态，这对于系统恢复、撤消更改或测试非常有用。

使用此端点将VPS实例还原为以前保存的状态。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot/restore

参数:

virtualMachineId：虚拟机ID（必需）

VPS_startVirtualMachineV1

启动指定的虚拟机。

如果虚拟机已在运行，则请求仍将被处理而不会产生任何影响。

使用此端点启动已停止的VPS实例。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/start

参数:

virtualMachineId：虚拟机ID（必需）

VPS_topVirtualMachineV1

停止指定的虚拟机。

如果虚拟机已经停止，则请求仍将被处理，不会产生任何影响。

使用此端点关闭正在运行的VPS实例。

方法: POST
路径: /api/vps/v1/virtual-machines/{virtualMachineId}/stop

参数:

virtualMachineId：虚拟机ID（必需）

Hostinger API MCP Server

快速接入

详细介绍