Hostinger
官方直接从IDE连接您的Hostinger账户,即可部署和管理网站。在一个地方处理网站、域名、DNS、VPS、电子商务、邮件营销和账单。
你可以用 Hostinger MCP 做什么?
- 从压缩包部署网站 — 请求从压缩包部署 Node.js 静态或 PHP 站点,自动上传文件并构建。
- 管理域名和 SSL — 关联/取消关联域名、更改主域名,以及安装、重新安装或移除 Let's Encrypt SSL 证书。
- 配置 PHP 和 WordPress — 切换 PHP 版本、启用扩展、设置 php.ini 选项,或更改 WordPress 核心版本和设置。
- 配置和监控网站 — 创建新的 Agency Plan 站点、检查设置状态、列出网站,并查看资源或磁盘使用指标。
- 处理数据库和定时任务 — 创建、列出或删除 MySQL 数据库/用户,并为网站安排或移除定时任务。
- 运行代理就绪扫描 — 启动并获取公共网站的 AI 代理就绪评分,以评估可发现性。
文档
hostinger-api-mcp
用于 Hostinger API 的模型上下文协议(MCP)服务器。
快速开始:托管远程服务器
如果您不想在本地安装或运行任何内容,可以直接连接到 Hostinger 的托管 MCP 服务器:
https://mcp.hostinger.com
Claude Code
claude mcp add --transport http hostinger https://mcp.hostinger.com
这将打开一个浏览器窗口以通过 OAuth 授权。批准后,您可以通过会话中的 execute 访问以下操作。
其他兼容 MCP 的客户端
在客户端的配置中将 https://mcp.hostinger.com 添加为远程 Streamable HTTP MCP 服务器,并在出现 OAuth 提示时完成授权。有关如何暴露“添加远程 MCP 服务器”/“自定义连接器”设置,请参阅客户端的文档。
前提条件
- Node.js 版本 24 或更高
如果您没有安装 Node.js,可以从官方网站下载。 或者,您可以使用 Homebrew(适用于 macOS)或 Chocolatey(适用于 Windows)等包管理器来安装 Node.js。
我们建议使用 NVM(Node 版本管理器) 来安装和管理已安装的 Node.js 版本。 安装 NVM 后,您可以使用以下命令安装 Node.js:
nvm install v24
nvm use v24
安装
要安装 MCP 服务器,请根据您的包管理器运行以下命令之一:
# Install globally from npm
npm install -g @hostinger/mcp
# Or with yarn
yarn global add @hostinger/mcp
# Or with pnpm
pnpm add -g @hostinger/mcp
更新
要将 MCP 服务器更新到最新版本,请根据您的包管理器使用以下命令之一:
# Update globally from npm
npm update -g @hostinger/mcp
# Or with yarn
yarn global upgrade @hostinger/mcp
# Or with pnpm
pnpm update -g @hostinger/mcp
二进制文件
此包安装以下 MCP 服务器命令:
hostinger-api-mcp— 涵盖所有操作(共 421 个)的统一服务器hostinger-agency-hosting-mcp— 42 个用于代理托管的操作hostinger-agent-readiness-mcp— 3 个用于代理就绪性的操作hostinger-billing-mcp— 9 个用于计费的操作hostinger-dns-mcp— 8 个用于 DNS 的操作hostinger-domains-mcp— 42 个用于域名的操作hostinger-ecommerce-mcp— 29 个用于电子商务的操作hostinger-horizons-mcp— 6 个用于 Horizons 的操作hostinger-hosting-mcp— 81 个用于托管的操作hostinger-mail-mcp— 38 个用于邮件的操作hostinger-reach-mcp— 56 个用于 Reach 的操作hostinger-vps-mcp— 67 个用于 VPS 的操作hostinger-wordpress-mcp— 40 个用于 WordPress 的操作
每个二进制文件都暴露相同的三个工具;作用域二进制文件仅搜索并执行自己组的操作。hostinger-api-mcp 仍然是向后兼容的默认值。
配置
运行服务器时可以配置以下环境变量:
DEBUG:启用调试日志记录(true/false)(默认:false)HOSTINGER_API_TOKEN:您的 API 令牌,将发送在Authorization标头中。设置后,OAuth 将被完全绕过。API_TOKEN:HOSTINGER_API_TOKEN的已弃用别名。将在未来版本中移除 — 请优先使用HOSTINGER_API_TOKEN。OAUTH_ISSUER:OAuth 服务器基础 URL(默认:https://auth.hostinger.com)。仅在未设置HOSTINGER_API_TOKEN时使用。
身份验证
服务器支持两种身份验证方法:
API 令牌(推荐用于 CI/脚本)
在环境中或 .env 文件中设置 HOSTINGER_API_TOKEN。存在时始终优先 — 不会运行 OAuth 代码。
带 PKCE 的 OAuth 2.0(交互式登录)
当未设置 HOSTINGER_API_TOKEN 且服务器以 stdio 模式运行时,将在首次经过身份验证的工具调用时自动使用带 PKCE 的 OAuth 2.0:
- 动态 OAuth 客户端向颁发者注册(RFC 7591)— 每台机器一次。
- 浏览器窗口打开到授权页面。
- 登录后,服务器在本地临时端口捕获重定向,将代码交换为令牌,并存储它们。
- 后续调用重用存储的访问令牌;过期的令牌会自动刷新。如果刷新令牌被撤销,将重新启动浏览器流程。
凭据存储在:
- macOS / Linux:
~/.config/hostinger-mcp/credentials.json(模式 0600) - Windows:
%APPDATA%\hostinger-mcp\credentials.json
凭据在所有 Hostinger MCP 二进制文件(hostinger-api-mcp、hostinger-vps-mcp 等)之间共享。
手动命令:
# Run the OAuth sign-in flow immediately (don't wait for the first tool call)
hostinger-api-mcp --login
# Revoke stored credentials
hostinger-api-mcp --logout
HTTP 传输说明: --http 模式不支持 OAuth 登录。使用 --http 之前请设置 HOSTINGER_API_TOKEN。
用法
适用于 Claude、Cursor 等的 JSON 配置
{
"mcpServers": {
"hostinger-api": {
"command": "hostinger-api-mcp",
"env": {
"DEBUG": "false",
"HOSTINGER_API_TOKEN": "YOUR API TOKEN"
}
}
}
}
传输选项
MCP 服务器支持两种传输模式:
标准 I/O 传输
服务器可以使用标准输入/输出(stdio)传输(默认)。这提供本地流式传输:
Streamable 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 (requires HOSTINGER_API_TOKEN env var)
--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)
--login Run OAuth sign-in flow and exit
--logout Revoke stored OAuth credentials and exit
--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.HOSTINGER_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);
// Execute an operation
const result = await client.callTool({
name: "execute",
arguments: { operation: "billing_catalog_list", params: { category: "DOMAIN" } }
});
console.log("Tool result:", result);
工具
每个服务器暴露三个工具:
search— 按关键字查找操作;返回每个匹配项及其inputSchema。execute— 运行一个操作:{ "operation": "<name>", "params": { ... } }。multi-execute— 按顺序运行最多 20 个操作,在第一次失败时停止。完全等于"$steps.<i>.<path>"的 params 值将被替换为早期步骤结果中的该值。
操作
通过 execute 可访问的操作,按二进制文件:
hostinger-agency-hosting-mcp
agency-hosting_deploy-node-static-website
从归档文件部署 node-static 代理计划(h5g)网站。警告:这会覆盖网站的现有内容且无法撤销 — 始终在继续之前与用户确认。用于类型为 node-static 的代理计划网站(需要构建步骤的 Node.js 构建的静态站点或简单的纯静态站点)。该工具从域名解析网站,通过 TUS 将归档上传到网站的文件浏览器,并触发 build-assets 过程,该过程构建站点并将结果部署到 public_html。此操作是同步的:构建和部署在工具返回之前完成,因此工具成功完成后网站立即可用 — 没有单独的异步构建需要等待或轮询。上传凭据在内部生成和使用 — 不要调用单独的 upload-url 端点或自行上传归档,此工具端到端完成。对于应按原样提取的纯 PHP 应用程序,请改用 agency-hosting_deploy-php-application。网站 UID 会自动从域名解析。
- 方法:
custom - 路径:
custom
agency-hosting_deploy-php-application
从归档文件部署 PHP(或其他非构建)代理计划(h5g)网站。警告:这会覆盖网站的现有内容且无法撤销 — 始终在继续之前与用户确认。用于归档内容应按原样提取并提供服务且无需构建步骤的代理计划网站(例如 PHP 应用程序)。该工具从域名解析网站,通过 TUS 将归档上传到网站的文件浏览器,并触发 import-archive 过程,该过程用归档内容覆盖网站内容。此操作是同步的:归档在工具返回之前被提取和部署,因此工具成功完成后网站立即可用 — 没有单独的异步构建需要等待或轮询。上传凭据在内部生成和使用 — 不要调用单独的 upload-url 端点或自行上传归档,此工具端到端完成。对于需要构建步骤的 node-static 网站,请改用 agency-hosting_deploy-node-static-website。网站 UID 会自动从域名解析。
- 方法:
custom - 路径:
custom
agency-hosting_datacenters_list
列出可用于在给定代理计划托管订单上配置新网站的数据中心。
每个数据中心包括一个 pinger_url,您可以从客户端 ping 以测量往返延迟;比较各数据中心的结果可以让您在选择其 code 作为创建网站设置时的 datacenter_code 之前选择最近的一个(最低 ping)。
- 方法:
GET - 路径:
/api/agency-hosting/v1/orders/{order_id}/datacenters
agency-hosting_domains_change-website
更改代理计划网站的主域名。
在路径中提供当前域名,在请求体中提供新域名。将域名设置为 null 以恢复为临时域名。
- 方法:
PUT - 路径:
/api/agency-hosting/v1/websites/{website_uid}/domains/{from_domain}
agency-hosting_domains_link-to-website
将域名链接到指定的代理计划网站,以便它可以为该域名提供流量。
- 方法:
POST - 路径:
/api/agency-hosting/v1/websites/{website_uid}/domains
agency-hosting_domains_list
返回与经过身份验证的客户端可访问的代理计划网站关联的分页域名列表。
使用 website_uuids 过滤器将结果缩小到特定网站。
- 方法:
GET - 路径:
/api/agency-hosting/v1/domains
agency-hosting_domains_unlink-from-website
从指定的代理计划网站取消链接域名。
该网站立即停止在此域名上提供流量。
网站文件和数据库被保留,任何其他链接的域名仍然可访问。
如果这是网站上唯一的域名,取消链接会使网站没有可访问的域名。
- 方法:
DELETE - 路径:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}
agency-hosting_files_generate-upload-url
生成带有身份验证凭据的文件浏览器上传 URL,用于将文件上传到代理计划网站的文件存储。
返回 url、auth_key 和 rest_auth_key。使用这些通过 TUS 可恢复上传协议(TUS 1.0.0)将文件上传到网站的文件存储。在每个请求上发送 X-Auth: {auth_key} 和 X-Auth-Rest: {rest_auth_key} 标头。
- 创建上传:
POST到{url}/{relative_file_path}?override=true,带有标头upload-length: {file size in bytes}和upload-offset: 0。期望201 Created。 - 上传文件:将文件字节发送到相同位置(任何 TUS 1.0.0 客户端,或带有跟踪进度的
upload-offset标头的PATCH请求)直到完成。
relative_file_path 是网站文件存储中的目标路径,例如 app.zip。
除了 TUS 客户端,普通的 curl 也可以工作:
FILE=app.zip
SIZE=$(stat -f%z "$FILE") # stat -c%s on Linux
curl -i -X POST "{url}/${FILE}?override=true" \
-H "X-Auth: {auth_key}" \
-H "X-Auth-Rest: {rest_auth_key}" \
-H "Tus-Resumable: 1.0.0" \
-H "Upload-Length: ${SIZE}" \
-H "Upload-Offset: 0"
# -> 201 Created
curl -i -X PATCH "{url}/${FILE}?override=true" \
-H "X-Auth: {auth_key}" \
-H "X-Auth-Rest: {rest_auth_key}" \
-H "Tus-Resumable: 1.0.0" \
-H "Content-Type: application/offset+octet-stream" \
-H "Upload-Offset: 0" \
--data-binary "@${FILE}"
# -> 204 No Content, Upload-Offset response header equals SIZE when done
- 方法:
POST - 路径:
/api/agency-hosting/v1/websites/{website_uid}/files/upload-urls
agency-hosting_files_import-website-from-archive
从已上传的归档导入代理计划网站。
首先通过文件浏览器将归档上传到网站的根目录,然后在此请求中提供其文件名。网站内容将被归档内容覆盖。支持的归档类型:.zip、.tar、.tar.gz、.tgz。
- 方法:
POST - 路径:
/api/agency-hosting/v1/websites/{website_uid}/files/import-archive
agency-hosting_metrics_list-plan-order-disk-usage
返回所选时间范围内代理计划订单的聚合磁盘和 inode 使用情况,以及计划配额。数据涵盖整个订单账户。值可能最多延迟一小时。CPU、内存和进程使用情况在 resource-usage-metrics 端点上。
- 方法:
GET - 路径:
/api/agency-hosting/v1/orders/{order_id}/disk-usage-metrics
agency-hosting_orders_list
返回经过身份验证的客户端可访问的代理计划订单的分页列表。
- 方法:
GET - 路径:
/api/agency-hosting/v1/orders
agency-hosting_metrics_list-order-resource-usage
返回所选时间范围内代理计划订单的聚合 CPU、内存和进程使用情况,以及计划配额和按网站细分的明细。每个网站由 uid 标识。暂停和删除的网站从订单总数和按网站细分中排除。值可能最多延迟一小时。磁盘和 inode 使用情况在 disk-usage-metrics 端点上。
- 方法:
GET - 路径:
/api/agency-hosting/v1/orders/{order_id}/resource-usage-metrics
agency-hosting_php_list-extensions-for-website
列出 Agency Plan 网站上可用的每个 PHP 扩展,以及当前是否已启用。
- 方法:
GET - 路径:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/extensions
agency-hosting_php_replace-website-extensions
将 Agency Plan 网站上启用的 PHP 扩展集合替换为所提供的扩展。请求中未包含的任何可切换扩展都会被禁用,因此请先调用扩展端点,然后发送完整的所需集合。编译进 PHP 的扩展(以“built-in”状态报告)始终处于活动状态,不受影响。
- 方法:
PUT - 路径:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/extensions
agency-hosting_php_list-options-for-website
列出可为 Agency Plan 网站配置的 php.ini 指令,每条指令均包含其默认值、当前生效的值以及可接受的值。
- 方法:
GET - 路径:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/options
agency-hosting_php_replace-website-options
将 Agency Plan 网站上的自定义 php.ini 值替换为所提供的值。请求中未包含的任何选项都会重置为其默认值,因此请先调用选项端点,然后发送完整的所需集合。发送空数组会将所有选项重置为其默认值。
- 方法:
PUT - 路径:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/options
agency-hosting_php_list-versions-for-order
列出在 Agency Plan 订单下创建的网站可用的 PHP 版本,具体取决于该订单所托管的服务器。在创建网站之前使用此端点;对于已存在的网站,请改用网站范围的版本端点。
- 方法:
GET - 路径:
/api/agency-hosting/v1/orders/{order_id}/websites/php-settings/versions
agency-hosting_php_list-versions-for-website
列出 Agency Plan 网站可以切换到的 PHP 版本。网站当前运行的版本由网站详情端点以 settings.php.version 返回。
- 方法:
GET - 路径:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/versions
agency-hosting_php_update-website-version
将 Agency Plan 网站切换到不同的 PHP 版本。请先调用可用版本端点,查看可以选择哪些版本。网站会以新版本重启,因此切换期间提供的请求可能会失败,与目标版本不兼容的代码将会中断。
- 方法:
PATCH - 路径:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/version
agency-hosting_website-setups_create
在您的某个 Agency Plan 托管订单上配置一个新的网站。
选择数据中心、技术栈(flavor)和 PHP 版本。可选地附加您自己的 domain —— 省略它、将其设置为 null,或让其不可用,则会生成一个免费的 *.hostingersite.com 子域名 —— 和/或通过提供 wordpress 详细信息(管理员账户、网站标题和语言)来安装 WordPress。
常见配置:
- 纯 PHP 网站:
flavor设置为php-fpm,并带有settings.php.version;省略wordpress和type。 - WordPress 网站:
flavor设置为所需的 WordPress 版本(例如wp-7.0),外加wordpress块(管理员账户、标题、语言)。 - 静态/Node.js 前端应用:
flavor设置为php-fpm,type设置为node-static。
配置在后台运行,因此响应会立即返回一个用于标识该任务的设置 UUID。配置完成后,新网站即可访问。
- 方法:
POST - 路径:
/api/agency-hosting/v1/orders/{order_id}/websites/setups
agency-hosting_website-setups_status
返回通过设置端点启动的 Agency Plan 网站设置的当前状态。
使用配置请求返回的 setup_uuid 轮询此端点,直到 status 变为 completed,此时 website_uid 标识新网站。
- 方法:
GET - 路径:
/api/agency-hosting/v1/orders/{order_id}/websites/setups/{setup_uuid}
agency-hosting_ssl_reinstall-website
替换域名的 Let's Encrypt 证书:当前平台证书(如有记录)会被吊销并移除,然后在后台启动新的设置。立即返回;Get website SSL status 在运行期间报告 installing,然后报告 active 或 failed。
对于免费子域名、当域名的证书流程有记录时(失败的设置在被清理前会计入),或当域名达到每七天三次设置的限制时,返回 422。当同一域名在一分钟前刚被请求时返回 429,当网站被暂停或锁定时返回 403,当网站或域名不存在时返回 404。
- 方法:
POST - 路径:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl/reinstall
agency-hosting_ssl_install-website
为域名启动 Let's Encrypt 证书设置并立即返回;设置会在后台运行。Get website SSL status 在运行期间报告 installing,然后报告 active 或 failed;List website processes 的 ssl_setup 条目显示相同的进度。
当域名已有未过期的平台证书、当域名的证书流程有记录时(失败的设置在被清理前会计入),或当域名达到每七天三次设置的限制时,返回 422。当同一域名在一分钟前刚被请求时返回 429,当网站被暂停或锁定时返回 403,当网站或域名不存在时返回 404。
- 方法:
POST - 路径:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl/setup
agency-hosting_ssl_website-status
返回 Agency Plan 网站某个域名的 SSL 状态:证书 status、证书是否由客户上传,以及证书何时失效。
installing 表示证书设置正在运行或重试;List website processes 的 ssl_setup 条目显示相同的进度。active 表示有效证书已就位:由客户上传、由平台签发,或为该域名购买的终身证书。failed 表示上次设置已放弃,且没有有效证书就位。expired 表示证书已过期。not_installed 表示该域名没有证书,也没有设置流程。当网站或域名不存在时返回 404。
- 方法:
GET - 路径:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl/status
agency-hosting_ssl_uninstall-website
移除域名的平台签发的 Let's Encrypt 证书:证书会在响应前被吊销并删除,因此在新的设置完成之前,该域名不再由平台证书提供服务。当域名没有可移除的平台证书时,此操作也会成功。上传的(自定义)证书不受影响。
当域名的证书流程有记录时(失败的设置在被清理前会计入)返回 422,当同一域名在一分钟前刚被请求时返回 429,当网站被暂停或锁定时返回 403,当网站或域名不存在时返回 404。
- 方法:
DELETE - 路径:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl
agency-hosting_websites_build-nodejs-assets
从已上传的归档文件构建并部署 Agency Plan 网站的 Node.js 应用程序。
先将归档文件上传到文件浏览器,然后在此请求中提供其相对于文档根目录的路径。网站内容会被构建结果覆盖,并部署到 public_html。
- 方法:
POST - 路径:
/api/agency-hosting/v1/websites/{website_uid}/build-assets
agency-hosting_cache_clear-website
清除与 Agency Plan 网站关联的所有域名的缓存,包括其预览域名。
此操作会清除该网站的所有缓存类型。
- 方法:
DELETE - 路径:
/api/agency-hosting/v1/websites/{website_uid}/cache
agency-hosting_cron-jobs_list-website
返回为 Agency Plan 网站配置的定时任务的分页列表。
每个条目都包含计划表达式以及在该计划上执行的命令。
- 方法:
GET - 路径:
/api/agency-hosting/v1/websites/{website_uid}/cron-jobs
agency-hosting_cron-jobs_create-website
根据计划表达式和命令为 Agency Plan 网站创建定时任务。
返回创建的定时任务,包括其 uuid,删除定时任务时需要用到该 uuid。
- 方法:
POST - 路径:
/api/agency-hosting/v1/websites/{website_uid}/cron-jobs
agency-hosting_cron-jobs_delete-website
从 Agency Plan 网站永久删除由其 uuid 标识的定时任务。
该操作是幂等的:删除不存在的定时任务也会成功,不会报错。
- 方法:
DELETE - 路径:
/api/agency-hosting/v1/websites/{website_uid}/cron-jobs/{uuid}
agency-hosting_databases_list-website
返回为 Agency Plan 网站创建的 MySQL 数据库的分页列表。
每个条目都包含该数据库的非系统用户。
- 方法:
GET - 路径:
/api/agency-hosting/v1/websites/{website_uid}/databases
agency-hosting_databases_create-website
为 Agency Plan 网站创建一个带有专用用户的 MySQL 数据库。
数据库名称、用户名和密码都必须由调用方提供。
- 方法:
POST - 路径:
/api/agency-hosting/v1/websites/{website_uid}/databases
agency-hosting_databases_delete-website
从 Agency Plan 网站永久删除一个 MySQL 数据库及其所有数据,包括其用户。
该操作是幂等的:删除不存在的数据库也会成功,不会报错。
- 方法:
DELETE - 路径:
/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}
agency-hosting_databases_create-website-user
为 Agency Plan 网站上现有的数据库创建一个用户。
每个数据库只支持一个非系统用户;为已有用户的数据库创建用户会失败。
- 方法:
POST - 路径:
/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}/users
agency-hosting_databases_delete-website-user
从 Agency Plan 网站数据库中永久删除一个数据库用户,撤销其拥有的所有访问权限。
该操作是幂等的:删除不存在的用户也会成功,不会报错。
- 方法:
DELETE - 路径:
/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}/users/{database_user_name}
agency-hosting_websites_get
检索特定 Agency Plan 网站的详细信息,包括配置、状态、元数据、托管计划详情和资源配额。
- 方法:
GET - 路径:
/api/agency-hosting/v1/websites/{website_uid}
agency-hosting_websites_delete
永久删除一个 Agency Plan 网站。删除是异步处理的:网站会立即转换为删除状态,底层服务器资源会在后台移除。
- 方法:
DELETE - 路径:
/api/agency-hosting/v1/websites/{website_uid}
agency-hosting_websites_list-plan
检索经过身份验证的客户端可访问的 Agency Plan 网站(H5G、Builder 和 Horizons)的分页列表。
此端点返回您托管账户中的网站,以及与您共享访问权限的其他客户端托管账户中的网站。
响应结构因平台而异——请参阅每个项目上的 platform 字段。
使用 website_types 仅列出给定检测类型的网站,例如仅 WordPress 网站(website_types=wordpress)或仅 Node.js 网站(website_types=nodejs)。与 order_ids、states 或 domain 结合使用可获得更有针对性的结果。
- 方法:
GET - 路径:
/api/agency-hosting/v1/websites
agency-hosting_websites_list-processes
列出 Agency Plan 网站的活动和最近完成的异步进程。
每个进程都有唯一的 ID(用于跟踪)、类型和状态(运行中、已完成、失败)。在启动异步操作(SSL 设置、备份、克隆)后轮询此端点以跟踪进度。
- 方法:
GET - 路径:
/api/agency-hosting/v1/websites/{website_uid}/processes
agency-hosting_wordpress_change-version
将 Agency Plan 网站上安装的 WordPress 核心版本更改为可安装版本之一。
- 方法:
PATCH - 路径:
/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings/version
agency-hosting_wordpress_settings
返回 Agency Plan 网站的当前 WordPress 设置:已安装的核心版本、 LiteSpeed Cache 插件状态、对象缓存状态和维护模式状态。
- 方法:
GET - 路径:
/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings
agency-hosting_wordpress_list-versions
列出可在 Agency Plan 网站上安装的 WordPress 核心版本。
- 方法:
GET - 路径:
/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings/versions
hostinger-agent-readiness-mcp
agent-readiness_checks_list
列出代理就绪扫描运行的所有检查,包括其名称、类别和权重。\n
使用它来显示扫描结果中每个 check_id 的人类可读名称。
- 方法:
GET - 路径:
/api/agent-readiness/v1/checks
agent-readiness_scans_run
开始扫描一个公共网站对 AI 代理的发现、阅读和操作就绪程度。\n
扫描是异步的:此操作仅启动扫描,返回的扫描通常为 pending
且尚无结果。要获取结果,请使用相同域名每隔几秒轮询 Get agent readiness scan 操作,
直到其状态为 completed 或 failed。扫描本身限制为 60 秒,
加上在队列中等待的时间。failed 的扫描不会重试;请重新运行此操作。\n
如果某个域名在过去 5 分钟内已有待处理的扫描,则启动新扫描会返回该扫描
而不是启动新扫描。
- 方法:
POST - 路径:
/api/agent-readiness/v1/scans
agent-readiness_scans_get
获取网站最新的代理就绪扫描。\n
通过 Run agent readiness scan 操作启动的扫描是异步的。当状态为
pending 时,结果字段为 null;请等待几秒后再次调用此操作,直到状态为
completed 或 failed。failed 的扫描不会重试;请重新运行扫描。\n
完成的扫描包含 0-100 的分数、字母等级、每个类别的分数,以及每项
检查的结果,包括发现的证据和修复方法。检查名称由 List checks 操作列出。\n
当域名从未被扫描时返回 404;请先使用 Run agent readiness scan 操作。
- 方法:
GET - 路径:
/api/agent-readiness/v1/scans/{domain}
hostinger-billing-mcp
billing_catalog_list
检索可订购的目录项目。
目录项目中的价格以分显示(不带浮点数),
例如:浮点数 17.99 显示为整数 1799。
在下单前使用此端点查看可用服务和定价。
- 方法:
GET - 路径:
/api/billing/v1/catalog
billing_orders_create-purchase
为任何 Hostinger 产品创建购买订单。
此统一端点为一个或多个目录项目下单,并
适用于所有 Hostinger 产品,利用现有的计费
基础设施。使用 目录端点 查找
可购买的 item_id 值。
如果未提供支付方式,将自动使用您的默认支付方式。
如果响应为 202 Accepted,则支付仍在处理中,订单将在
支付确认后异步完成。
此端点仅下单。产品特定的配置 (例如 VPS 设置或域名注册)不在此处执行——订单 完成后,请使用相关的产品端点或 hPanel 完成设置。
使用此端点购买目录中可用的任何产品。
- 方法:
POST - 路径:
/api/billing/v1/orders
billing_payment-methods_set-default
设置您账户的默认支付方式。
使用此端点为未来的订单配置主要支付方式。
- 方法:
POST - 路径:
/api/billing/v1/payment-methods/{paymentMethodId}
billing_payment-methods_delete
从您的账户中删除支付方式。
使用此端点从用户账户中移除未使用的支付方式。
- 方法:
DELETE - 路径:
/api/billing/v1/payment-methods/{paymentMethodId}
billing_payment-methods_list
检索可用于下新订单的可用支付方式。
如果您想添加新的支付方式, 请使用 hPanel。
在创建订单前使用此端点查看可用的支付选项。
- 方法:
GET - 路径:
/api/billing/v1/payment-methods
billing_subscriptions_list
检索与您的账户关联的所有订阅列表。
使用此端点监控活动服务和计费状态。
- 方法:
GET - 路径:
/api/billing/v1/subscriptions
billing_subscriptions_disable-auto-renewal
禁用订阅的自动续费。
在禁用订阅的自动续费时使用此端点。
- 方法:
DELETE - 路径:
/api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/disable
billing_subscriptions_enable-auto-renewal
启用订阅的自动续费。
在启用订阅的自动续费时使用此端点。
- 方法:
PATCH - 路径:
/api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/enable
billing_subscriptions_renew
为现有的 Hostinger 订阅创建续费订单。
此端点为单个订阅下续费订单,利用
现有的计费基础设施。使用
订阅端点 查找
可续费的 subscriptionId 值。
如果未提供支付方式,将自动使用您的默认支付方式。
如果响应为 202 Accepted,则支付仍在处理中,续费将在
支付确认后异步完成。
使用此端点续费您账户中可用的任何订阅。
- 方法:
POST - 路径:
/api/billing/v1/subscriptions/{subscriptionId}/renew
hostinger-dns-mcp
dns_snapshots_get
检索包含 DNS 区域记录内容的特定 DNS 快照。
使用此端点查看域名的历史 DNS 配置。
- 方法:
GET - 路径:
/api/dns/v1/snapshots/{domain}/{snapshotId}
dns_snapshots_list
检索域名的 DNS 快照。
使用此端点查看可用于恢复的 DNS 备份点。
- 方法:
GET - 路径:
/api/dns/v1/snapshots/{domain}
dns_snapshots_restore
将 DNS 区域恢复到所选快照。
使用此端点将域名 DNS 恢复到之前的配置。
- 方法:
POST - 路径:
/api/dns/v1/snapshots/{domain}/{snapshotId}/restore
dns_records_list
检索特定域名的 DNS 区域记录。
使用此端点查看当前 DNS 配置以进行域名管理。
- 方法:
GET - 路径:
/api/dns/v1/zones/{domain}
dns_records_update
更新所选域名的 DNS 记录。
使用 overwrite = true 将用提供的记录替换现有记录。
否则,现有记录将被更新,新记录将被添加。
使用此端点修改域名 DNS 配置。
- 方法:
PUT - 路径:
/api/dns/v1/zones/{domain}
dns_records_delete
删除所选域名的 DNS 记录。
要筛选要删除的记录,请将记录的 name 和 type 添加到筛选器中。
单个请求中可以提供多个筛选器。
如果您有多个名称和类型相同的记录,并且只想删除其中一部分,
请参阅 Update zone records 端点。
使用此端点从域名中移除特定的 DNS 记录。
- 方法:
DELETE - 路径:
/api/dns/v1/zones/{domain}
dns_records_reset
将 DNS 区域重置为默认记录。
使用此端点将域名 DNS 恢复到原始配置。
- 方法:
POST - 路径:
/api/dns/v1/zones/{domain}/reset
dns_records_validate
在更新所选域名的 DNS 记录之前进行验证。
如果验证成功,响应将包含 200 Success 代码。
如果存在验证错误,响应将失败并返回 422 Validation error 代码。
在应用更改之前使用此端点验证 DNS 记录的有效性。
- 方法:
POST - 路径:
/api/dns/v1/zones/{domain}/validate
hostinger-domains-mcp
domains_verifications_direct
检索待处理和已完成的域名验证列表。
- 方法:
GET - 路径:
/api/v2/direct/verifications/active
domains_availability_suggest-names-from-description
根据您项目的自由文本描述建议可用的域名。
建议由 AI 模型生成,因此每次调用结果可能不同。
端点速率限制为每分钟 90 个请求。
当您只知道网站内容而不知道域名时,使用此端点查找域名。
- 方法:
POST - 路径:
/api/domains/v1/availability/alternatives-from-description
domains_availability_suggest-names-from
根据您已想到的域名建议可用的域名。
建议由 AI 模型生成,因此每次调用结果可能不同。
端点速率限制为每分钟 90 个请求。
当您想要的域名已被占用且需要相近的替代方案时,使用此端点。
- 方法:
POST - 路径:
/api/domains/v1/availability/alternatives-from-domain
domains_availability_check
检查多个 TLD 下域名的可用性。
可以同时检查多个 TLD。
如果您希望响应中包含替代域名,请仅提供一个 TLD 并将 with_alternatives 设置为 true。
TLD 应不带前导点提供(例如 com、net、org)。
端点速率限制为每分钟 90 个请求。
在购买前使用此端点验证域名可用性。
- 方法:
POST - 路径:
/api/domains/v1/availability
domains_forwarding_get
检索域名转发数据。
使用此端点查看域名的当前重定向配置。
- 方法:
GET - 路径:
/api/domains/v1/forwarding/{domain}
domains_forwarding_update
更新域名转发配置。
使用此端点修改域名的现有重定向配置。
- 方法:
PUT - 路径:
/api/domains/v1/forwarding/{domain}
domains_forwarding_delete
删除域名转发数据。
使用此端点从域名中移除重定向配置。
- 方法:
DELETE - 路径:
/api/domains/v1/forwarding/{domain}
domains_forwarding_create
创建域名转发配置。
使用此端点设置域名重定向到其他 URL。
- 方法:
POST - 路径:
/api/domains/v1/forwarding
domains_whois_pending-irtp-verification
检索域名的待处理 IRTP 验证。
旧注册人和新注册人都必须确认,WHOIS 更改才能生效。
使用此端点检查等待注册人确认的 WHOIS 更改状态。
- 方法:
GET - 路径:
/api/domains/v1/irtp/{domain}
domains_whois_cancel-pending-irtp-verification
取消待处理的 IRTP 验证。
使用此端点退出卡在等待注册人确认的 WHOIS 更改, 例如当无法收到确认邮件时,无需等待 5 天过期。
- 方法:
DELETE - 路径:
/api/domains/v1/irtp/{domain}
domains_move_incoming
检索指定域名的传入转移。
当没有账户正在将此域名转移给您时返回 404。
使用此端点检查发送给您的域名是否仍在等待接受。
- 方法:
GET - 路径:
/api/domains/v1/move/incoming/{domain}
domains_move_accept-incoming
接受指定域名的传入转移。
提供的 WHOIS 配置文件将成为域名的联系人,因此它们必须属于 您的账户并满足 TLD 的要求。仅应用域名实际使用的联系人类型, 但必须提供所有四个配置文件 ID。
转移必须仍在等待您的决定,已接受的转移
不能再次接受。
接受操作并不会立即完成转移。系统会向新所有者联系人的邮箱发送一封确认邮件,域名只有在通过该邮件确认变更后才会完成过户。在此之前,转移将保持在 activating 状态,您可以通过转入端点跟踪该状态。
使用此端点接受提供给您的域名所有权。
- 方法:
PUT - 路径:
/api/domains/v1/move/incoming/{domain}
domains_move_reject-incoming
拒绝指定域名的转入请求。
域名将保留在发起转移的账户中。已经接受的转移无法再被拒绝。
使用此端点拒绝您不想接管的域名。
- 方法:
DELETE - 路径:
/api/domains/v1/move/incoming/{domain}
domains_move_incoming-list
检索所有其他 Hostinger 账户正在转入您账户的域名。
将返回所有状态的转移记录,包括已经完成的。
使用此端点查找等待您接受的域名。
- 方法:
GET - 路径:
/api/domains/v1/move/incoming
domains_move_outgoing
检索指定域名的转出记录。
当域名没有进行中的转移时,返回 404。
使用此端点跟踪您为单个域名发起的转移状态。
- 方法:
GET - 路径:
/api/domains/v1/move/outgoing/{domain}
domains_move_start-outgoing
发起将指定域名转移到另一个 Hostinger 账户的操作。
接收账户必须已存在,并且在域名过户前接受该转移。
域名必须处于激活状态。其所属的订阅会自动解析,如果域名没有自己的域名订阅,请求将以 404 状态码被拒绝。
受高级保护(premium protection)保护的域名需要额外的验证步骤,此类请求将以 428 状态码被拒绝。
使用此端点将域名移交给另一位 Hostinger 用户。
- 方法:
POST - 路径:
/api/domains/v1/move/outgoing/{domain}
domains_move_cancel-outgoing
取消指定域名的转出操作。
只有在接收账户尚未接受转移时才能取消。域名将保留在您的账户中。
使用此端点撤回您不再希望完成的转移。
- 方法:
DELETE - 路径:
/api/domains/v1/move/outgoing/{domain}
domains_move_outgoing-list
检索所有您正在转移到其他 Hostinger 账户的域名。
仅返回尚未完成的转移。
使用此端点跟踪您已发起的转移及其目标账户。
- 方法:
GET - 路径:
/api/domains/v1/move/outgoing
domains_portfolio_authorization-code
检索指定域名的授权(EPP)代码,以便将其从 Hostinger 转移到其他注册商。
请求新代码会使之前检索的任何代码失效。
使用此端点获取将域名转移到其他注册商所需的代码。
- 方法:
GET - 路径:
/api/domains/v1/portfolio/{domain}/auth-code
domains_portfolio_claim-free
认领您账户中可用的免费域名并进行注册。
与购买域名不同,此操作会消耗您已有的免费域名,因此无需支付方式。
成功的响应表示域名已注册。如果注册失败,请登录 hPanel 检查域名注册状态。
如果未提供 WHOIS 信息,将使用该 TLD 的默认联系信息。在发起请求前,请确保您的账户中存在所需 TLD 的 WHOIS 信息。
某些 TLD 要求提供 additional_details,这些信息将在认领前进行验证。
无法满足的请求将在响应正文中返回错误代码,例如在没有可用免费域名时返回 2037。
使用此端点使用您账户中的免费域名注册域名。
- 方法:
POST - 路径:
/api/domains/v1/portfolio/claim
domains_portfolio_enable-lock
为域名启用域名锁。
启用域名锁后,必须先禁用锁才能将域名转移到其他注册商。
使用此端点保护域名免受未经授权的转移。
- 方法:
PUT - 路径:
/api/domains/v1/portfolio/{domain}/domain-lock
domains_portfolio_disable-lock
为域名禁用域名锁。
在将域名转移到其他注册商之前,需要禁用域名锁。
使用此端点准备将域名转移到其他注册商。
- 方法:
DELETE - 路径:
/api/domains/v1/portfolio/{domain}/domain-lock
domains_portfolio_get
检索指定域名的详细信息。
使用此端点查看全面的域名配置和状态。
- 方法:
GET - 路径:
/api/domains/v1/portfolio/{domain}
domains_portfolio_list
检索与您账户关联的所有域名。
使用此端点查看用户的域名组合。
- 方法:
GET - 路径:
/api/domains/v1/portfolio
domains_portfolio_purchase
购买并注册新的域名。
如果注册失败,请登录 hPanel 检查域名注册状态。
如果未提供支付方式,将自动使用您的默认支付方式。
如果响应为 202 Accepted,则表示付款仍在处理中,域名尚未注册。订单完成后,请从 hPanel 注册域名。
如果未提供 WHOIS 信息,将使用该 TLD 的默认联系信息。在发起请求前,请确保您的账户中存在所需 TLD 的 WHOIS 信息。
某些 TLD 要求提供 additional_details,这些信息将在完成购买前进行验证。
使用此端点为用户注册新域名。
- 方法:
POST - 路径:
/api/domains/v1/portfolio
domains_portfolio_enable-privacy-protection
为域名启用隐私保护。
启用隐私保护后,域名所有者的个人信息将从公共 WHOIS 数据库中隐藏。
使用此端点保护域名所有者的个人信息不被公开查看。
- 方法:
PUT - 路径:
/api/domains/v1/portfolio/{domain}/privacy-protection
domains_portfolio_disable-privacy-protection
为域名禁用隐私保护。
禁用隐私保护后,域名所有者的个人信息将在公共 WHOIS 数据库中可见。
使用此端点使域名所有者的信息公开可见。
- 方法:
DELETE - 路径:
/api/domains/v1/portfolio/{domain}/privacy-protection
domains_portfolio_renewal-information
检索指定域名的续费信息,包括其状态和当前到期日期。
使用此端点为单个域名构建续费自动化和到期监控。
- 方法:
GET - 路径:
/api/domains/v1/portfolio/{domain}/renewal
domains_portfolio_complete-setup
注册您已付费但尚未设置的域名。
当订单完成但未注册域名时使用此端点,例如当 Purchase new domain 返回 202 Accepted 且域名已添加到您的账户但未注册时,或者当之前的设置尝试失败时。不会下达新订单,也不会收取费用:将使用您已拥有的订阅,期限为您已支付的期限。
当订单完成时,如果注册所需的详细信息缺失或无效,域名将处于等待设置状态。在其他地方订购的域名也可能因相同原因处于等待设置状态。请补全缺失的信息,然后调用此端点。如果订单本身尚未完成,域名不在您的账户中,请等待其出现在 Get domain list 中。
如果省略 domain_contacts,则该 TLD 的默认 WHOIS 配置文件将用于所有四个角色。该配置文件必须存在且完整,不完整的配置文件是域名处于等待设置状态的最常见原因。使用 Create WHOIS profile 创建一个。
某些 TLD 要求提供 additional_details。这些信息在设置前进行验证,因此缺失或无效的值将被拒绝,不会尝试任何注册。
域名将使用默认名称服务器设置,且不启用隐私保护。之后使用 Update domain nameservers 和 Enable privacy protection 更改任一设置。
成功的响应表示设置请求已被接受,并不代表域名已经注册。轮询 Get domain list 以获取结果,域名只有在注册完成后才会出现在 Get domain details 中。
使用此端点完成账户中等待设置的域名的注册。
- 方法:
POST - 路径:
/api/domains/v1/portfolio/{domain}/setup
domains_portfolio_update-nameservers
为指定域名设置名称服务器。
请注意,不正确的名称服务器配置可能导致域名无法解析或不可用。
使用此端点为域名配置自定义 DNS 托管。
- 方法:
PUT - 路径:
/api/domains/v1/portfolio/{domain}/nameservers
domains_transfer_claim-free
认领您账户中可用的免费域名转移并开始转移。
与购买转移不同,此操作会消耗您已有的免费域名转移,因此无需支付方式。
在发起请求前,请在当前注册商处解锁域名并获取其授权代码。转移会先进行验证,因此无法转移的域名会在消耗免费域名转移之前被拒绝。
成功的响应表示转移已开始。完成取决于当前注册商,可以通过转移列表端点跟踪。
如果未提供 WHOIS 信息,将使用该 TLD 的默认联系信息。在发起请求前,请确保您的账户中存在所需 TLD 的 WHOIS 信息。
无法满足的请求将在响应正文中返回错误代码。
使用此端点使用您账户中的免费域名转移来转移域名。
- 方法:
POST - 路径:
/api/domains/v1/transfers/claim
domains_transfer_get
检索指定域名的转移记录。
使用此端点跟踪转入或转出的注册商转移及其状态。
- 方法:
GET - 路径:
/api/domains/v1/transfers/{domain}
domains_transfer_list
检索您组合中的所有域名转移记录。
使用此端点监控您所有域名的转入和转出注册商转移。
- 方法:
GET - 路径:
/api/domains/v1/transfers
domains_transfer_start
将域名从其他注册商转移到您的账户。
转移使用您已购买的域名转移服务进行。
在发起请求前,请在当前注册商处解锁域名并获取其授权代码。
成功的响应表示转移已开始。完成取决于当前注册商,可以通过转移列表端点跟踪。
如果未提供 WHOIS 信息,将使用该 TLD 的默认联系信息。在发起请求前,请确保您的账户中存在所需 TLD 的 WHOIS 信息。
使用此端点将注册在其他地方的域名带入您的账户。
- 方法:
POST - 路径:
/api/domains/v1/transfers
domains_whois_change-for
更改域名的 WHOIS 联系配置文件。
将指定的联系角色重新指向新的 WHOIS 配置文件,并将更改提交给注册局。当前分配给这些角色的配置文件会自动解析;如果给定的角色当前不在同一配置文件上,请求将失败。
更改所有者联系人的转移敏感字段将启动 IRTP 验证。
更改将异步处理。
使用此端点将已注册域名迁移到不同的联系信息。
- 方法:
PUT - 路径:
/api/domains/v1/whois/change
domains_whois_set-as-default
将 WHOIS 联系配置文件设置为默认。 默认配置文件会在注册新域名时,根据其所属的顶级域(TLD)被预先选中。
使用此端点可避免在每次注册时都需选择联系信息。
- 方法:
PUT - 路径:
/api/domains/v1/whois/default/{whoisId}
domains_whois_unset-default
取消将 WHOIS 联系配置文件设为默认。
配置文件本身会被保留,只是不再为其所属的 TLD 预先选中。
使用此端点可停止在新注册中复用联系信息。
- 方法:
DELETE - 路径:
/api/domains/v1/whois/default/{whoisId}
domains_whois_get
检索 WHOIS 联系配置文件。
使用此端点可查看域名注册联系信息。
- 方法:
GET - 路径:
/api/domains/v1/whois/{whoisId}
domains_whois_delete
删除 WHOIS 联系配置文件。
使用此端点可从账户中移除未使用的联系配置文件。
- 方法:
DELETE - 路径:
/api/domains/v1/whois/{whoisId}
domains_whois_list
检索 WHOIS 联系配置文件。
使用此端点可查看可用于域名注册的联系配置文件。
- 方法:
GET - 路径:
/api/domains/v1/whois
domains_whois_create
创建 WHOIS 联系配置文件。
使用此端点可添加新的域名注册联系信息。
- 方法:
POST - 路径:
/api/domains/v1/whois
domains_whois_usage
检索使用了指定 WHOIS 联系配置文件的域名列表。
使用此端点可查看哪些域名使用了特定的联系配置文件。
- 方法:
GET - 路径:
/api/domains/v1/whois/{whoisId}/usage
hostinger-ecommerce-mcp
ecommerce_discounts_list
列出商店的折扣。可按代码和名称的自由文本或禁用状态进行筛选。 固定折扣的金额为最小货币单位的整数;百分比折扣的值为 1 到 100 之间的整数。
- 方法:
GET - 路径:
/api/ecommerce/v1/stores/{store_id}/discounts
ecommerce_discounts_create
为商店创建折扣。固定折扣的金额以最小货币单位表示(例如 $10 为 1000);百分比折扣的值为 1 到 100 之间的整数。 免运费折扣忽略金额值。返回创建的折扣。
- 方法:
POST - 路径:
/api/ecommerce/v1/stores/{store_id}/discounts
ecommerce_miscellaneous_custom-storefront-setup-instructions
检索分步设置说明(格式为 Markdown),用于将自定义销售渠道连接到您的商店,并通过 Ecommerce API 保持目录、订单、配送和付款同步。
- 方法:
GET - 路径:
/api/ecommerce/v1/miscellaneous/custom-storefront-instructions
ecommerce_orders_cancel
取消订单,并可选择通过电子邮件通知客户。返回更新后的订单摘要。
- 方法:
POST - 路径:
/api/ecommerce/v1/stores/{store_id}/orders/{order_id}/cancel
ecommerce_orders_fulfil
在一次调用中为订单创建履约记录并附加跟踪信息。省略商品项将履约所有剩余未履约的商品。返回更新后的订单摘要。
- 方法:
POST - 路径:
/api/ecommerce/v1/stores/{store_id}/orders/{order_id}/fulfill
ecommerce_orders_list-store
按最新优先的顺序列出商店的订单摘要。可按状态、付款或履约状态、客户电子邮件、订单号或自由文本查询进行筛选。金额以最小货币单位表示。检索单个订单以获取其商品项、地址和履约记录。
- 方法:
GET - 路径:
/api/ecommerce/v1/stores/{store_id}/orders
ecommerce_orders_retrieve
完整检索单个订单:商品项(每个都包含履约端点所需的 ID)、地址、总额明细以及带跟踪信息的履约记录。金额以最小货币单位表示。
- 方法:
GET - 路径:
/api/ecommerce/v1/stores/{store_id}/orders/{order_id}
ecommerce_payments_enable-manual-method
启用手动付款方式,以便商店无需在线支付提供商即可接受订单。
- 方法:
POST - 路径:
/api/ecommerce/v1/stores/{store_id}/payment-methods/manual
ecommerce_payments_create-provider-connect-link
创建用于将支付网关连接到商店的引导链接。返回供商家打开的网关引导 URL 以及指向商店管理后台的深层链接。
- 方法:
POST - 路径:
/api/ecommerce/v1/stores/{store_id}/payment-providers/{provider_id}/connect-link
ecommerce_payments_list-store-providers
列出商店的支付提供商,分为已连接到商店的提供商和可安装的网关。绝不暴露网关凭据、密钥或配置。
- 方法:
GET - 路径:
/api/ecommerce/v1/stores/{store_id}/payment-providers
ecommerce_products_create-image-upload-url
返回一个签名 URL,用于上传产品图片(multipart/form-data POST)。然后使用返回的 object_name 调用 attach-image 端点以扫描图片并将其附加到产品。
- 方法:
POST - 路径:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/images/upload-url
ecommerce_products_delete
从商店中删除产品及其变体。具有有效订阅者的订阅产品将被归档而非删除,以便其数据保持可用。
- 方法:
DELETE - 路径:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}
ecommerce_products_update
更新产品的名称、描述、状态、SEO 设置或集合。将状态设置为 published 使其可购买,draft 以隐藏,或 archived 以停用。未提供的 SEO 设置(标题、描述、slug)将保留其现有值。collection_changes 添加或移除集合,而不影响其他集合。变体、价格和库存通过变体端点管理,而非此处。返回更新后的产品摘要。
- 方法:
PATCH - 路径:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}
ecommerce_products_create-digital
创建已发布的数字产品,包含单个变体和可选的外部下载链接。
- 方法:
POST - 路径:
/api/ecommerce/v1/stores/{store_id}/products/digital
ecommerce_products_list
按最新优先的顺序列出商店的产品,作为精简摘要(名称、状态、缩略图、变体数量和价格范围)。价格为最小货币单位的整数,并存在于变体上。可按状态、自由文本或一组产品 ID 进行筛选。使用 include=variants 嵌入每个产品的变体及其价格和库存,使用 include=media 嵌入其媒体。
- 方法:
GET - 路径:
/api/ecommerce/v1/stores/{store_id}/products
ecommerce_products_create-physical
创建已发布的实体产品,包含以商店货币定价的单个变体。
- 方法:
POST - 路径:
/api/ecommerce/v1/stores/{store_id}/products/physical
ecommerce_products_upload-and-attach-image
从 URL 获取光栅图像(JPEG、PNG、GIF 或 WebP,最大 15MB),并在一次调用中将其附加到产品。图像下载要求使用 HTTPS 且端口为 443,不包含嵌入式凭据。最多允许一次重定向,且其目标必须满足相同要求。私有或保留网络目标、不支持的 URL 和更长的重定向链将被拒绝。图像将进行病毒扫描并按内容验证,然后存储在 CDN 上。设置 is_thumbnail 使其成为产品的主图像。
- 方法:
POST - 路径:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/images
ecommerce_sales-channels_list
列出商店的活跃销售渠道及其完整元数据。
- 方法:
GET - 路径:
/api/ecommerce/v1/stores/{store_id}/sales-channels
ecommerce_sales-channels_create
为商店创建销售渠道。“custom”渠道是无头的:构建您自己的前端,并通过 Ecommerce API 保持目录、订单、配送和付款同步。“quick-link”渠道是托管的单页商店,其句柄是自动生成的。
- 方法:
POST - 路径:
/api/ecommerce/v1/stores/{store_id}/sales-channels
ecommerce_sales-channels_update
更新自定义销售渠道。面向商家的 name 和公开的 url(作为渠道 domain 返回)可以更改。传递 null 以清除某个值。
- 方法:
PATCH - 路径:
/api/ecommerce/v1/stores/{store_id}/sales-channels/{sales_channel_id}
ecommerce_shipping_set-store
设置商店的固定运费,如果配送区域尚不存在则创建。
- 方法:
POST - 路径:
/api/ecommerce/v1/stores/{store_id}/shipping
ecommerce_stores_delete
软删除您账户拥有的商店。
底层商店数据会被保留;仅将商店标记为已删除。
- 方法:
DELETE - 路径:
/api/ecommerce/v1/stores/{store_id}
ecommerce_stores_list
检索与您账户关联的商店。
- 方法:
GET - 路径:
/api/ecommerce/v1/stores
ecommerce_stores_create
为您的账户创建新商店。
创建商店时会同时创建一个主要销售渠道。
- 方法:
POST - 路径:
/api/ecommerce/v1/stores
ecommerce_stores_metadata
获取商店的就绪元数据:付款方式和配送是否已配置,以及其默认货币。可用于在构建店面之前验证先决条件。
- 方法:
GET - 路径:
/api/ecommerce/v1/stores/{store_id}/metadata
ecommerce_product-variants_update-in-batch
按 ID 就地更新最多 100 个现有变体——标题、SKU、库存、库存跟踪和价格。请求中未包含的变体保持不变。价格将完全替换变体的现有价格。返回更新后的变体。
- 方法:
PATCH - 路径:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants/batch
ecommerce_product-variants_delete
从产品中删除单个变体。
- 方法:
DELETE - 路径:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants/{variant_id}
ecommerce_product-variants_list
按排序顺序列出产品的变体,包含其选项、价格和库存。价格为最小货币单位的整数,并存在于变体上。
- 方法:
GET - 路径:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants
ecommerce_product-variants_create
沿一个或多个选项维度(例如尺寸、颜色)向产品添加变体。产品中缺失的选项会自动创建;为产品已有的每个选项提供一个值。价格为最小货币单位的整数,默认使用商店货币。返回创建的变体。
- 方法:
POST - 路径:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants
hostinger-horizons-mcp
horizons_websites_clone
将 Hostinger Horizons 网站克隆到一个新网站。\n
当用户想要现有网站的副本时使用此工具,例如尝试更改而不影响原始网站。\n
此工具返回新创建副本的 ID 和 URL。原始网站保持不变。\n
要编辑副本,请使用 Edit website 工具并传入返回的网站 ID,或者用户可以在 Hostinger Horizons 界面中打开提供的网站 URL。
- 方法:
POST - 路径:
/api/horizons/v1/websites/{websiteId}/clone
horizons_websites_list
列出用户拥有的 Hostinger Horizons 网站。\n 当用户询问他们拥有哪些网站,或当您需要在编辑、发布或克隆网站之前获取网站 ID 时,使用此工具。\n 每个网站都返回其 ID、状态、域名以及在 Hostinger Horizons 界面中打开的 URL。\n 完整的网站列表在单个响应中返回——不分页。
- 方法:
GET - 路径:
/api/horizons/v1/websites
horizons_websites_create
根据给定的消息创建新的 Hostinger Horizons 网站。\n
当用户要求您创建网站、落地页、博客或任何其他类型的应用程序时,请使用此工具。\n
此工具启动网站创建过程,并返回网站 URL 和 ID。\n
生成过程是异步进行的。\n
调用此工具后,您的聊天回复必须恰好为 1 句话,总结说明 Hostinger Horizons 正在创建他们的网站,并且将在几分钟内准备好,同时您应立即向用户提供网站 URL。\n
不要编写代码。\n\n如需后续编辑,请使用返回的网站 ID 调用 Edit website 工具,或者用户可以在提供的网站 URL 中进入 Hostinger Horizons 界面。\n
如果工具调用失败并出现错误,您应提供清晰的错误说明,并且不要在聊天中自行生成代码。\n
\n
技术栈限制(严格执行):\n
环境仅限于以下技术。\n
您不得使用、建议或实现此列表之外的任何技术:\n
\n
-
语言:仅限 JavaScript。\n
-
诸如 TypeScript、Rust、Python、Java、PHP 等语言严格禁止使用。\n
-
框架:React。\n
-
导航:React Router。\n
-
样式:TailwindCSS。\n
-
组件:shadcn/ui(基于 @radix-ui primitives 构建)。\n
-
图标:Lucide React。\n
-
动画:Framer Motion。\n \n 后端与数据存储:\n
-
Horizons 集成后端是持久化数据存储、身份验证和数据库需求的唯一解决方案。\n
-
严格禁止使用本地数据库(SQLite、MySQL 等)。\n
-
仅当用户明确要求时,才允许使用第三方服务(Firebase、AWS Amplify)。\n \n 地图:\n
-
OpenStreetMap 是默认提供商。\n
-
仅当用户明确要求时,才允许使用替代提供商(Google Maps、Mapbox)。\n
-
方法:
POST -
路径:
/api/horizons/v1/websites
horizons_websites_edit
使用后续消息编辑现有的 Hostinger Horizons 网站。\n 当用户想要更改、扩展或修复已存在的网站时,请使用此工具。\n 此工具将请求的更改排队,并返回网站 URL 和 ID。\n 更改是异步应用的。\n 调用此工具后,您的聊天回复必须恰好为 1 句话,总结说明 Hostinger Horizons 正在应用请求的更改,并且将在几分钟内准备好,同时您应立即向用户提供网站 URL。\n 不要编写代码。\n 如果工具调用失败并出现错误,您应提供清晰的错误说明,并且不要在聊天中自行生成代码。
- 方法:
POST - 路径:
/api/horizons/v1/websites/{websiteId}/messages
horizons_websites_publish
发布 Hostinger Horizons 网站,使其最新更改生效。\n
当用户要求发布、部署或使网站上线时,请使用此工具。\n
此工具启动发布过程,并返回网站将上线所在的 URL。\n
发布是异步进行的,需要几分钟时间。\n
仅当用户明确要求将网站作为模板共享时,才设置 is_template:\ntrue 会在其已发布页面上添加“使用模板”横幅,将网站复制到访问者自己的账户中,而 false 会移除该横幅。省略此参数以保持当前设置。\n
调用此工具后,您的聊天回复必须恰好为 1 句话,总结说明网站正在发布,并且您应立即向用户提供已发布的 URL。
- 方法:
POST - 路径:
/api/horizons/v1/websites/{websiteId}/publish
horizons_websites_get
获取用户在其 Hostinger Horizons 界面中打开网站的链接。\n
当用户想要现有网站的链接,或者您在编辑之前或之后需要其网站 URL 时,请使用此工具。\n
is_in_progress 在更改正在生成或网站正在发布时为 true;请等到其为 false 后再发布。published_at 是网站上次发布的时间,is_template 表示其已发布页面是否显示“使用模板”横幅,has_ecommerce_store 表示其是否具有在线商店。\n
网站可以使用 Edit website 工具进行编辑,或者由用户在提供的网站 URL 中的 Hostinger Horizons 界面中进行编辑。
- 方法:
GET - 路径:
/api/horizons/v1/websites/{websiteId}
hostinger-hosting-mcp
hosting_import-wordpress-website
从存档文件将 WordPress 网站导入到托管服务器。此工具上传网站存档(zip、tar、tar.gz 等)和数据库转储(.sql 文件)以部署完整的 WordPress 网站。存档将在服务器上自动解压。注意:对于较大的网站,此过程可能需要一些时间。上传完成后,文件正在解压,网站将在几分钟内可用。上传凭据是生成并在内部使用的——不要调用单独的 upload-url 端点或自行上传文件,此工具端到端完成此操作。用户名将根据域名自动解析。
- 方法:
custom - 路径:
custom
hosting_deploy-wordpress-plugin
从目录将 WordPress 插件部署到托管服务器。此工具上传所有插件文件并触发插件部署。上传凭据是生成并在内部使用的——不要调用单独的 upload-url 端点或自行上传文件,此工具端到端完成此操作。
- 方法:
custom - 路径:
custom
hosting_deploy-wordpress-theme
从目录将 WordPress 主题部署到托管服务器。此工具上传所有主题文件并触发主题部署。上传的主题可以在部署后选择性地激活。上传凭据是生成并在内部使用的——不要调用单独的 upload-url 端点或自行上传文件,此工具端到端完成此操作。
- 方法:
custom - 路径:
custom
hosting_deploy-js-application
从存档文件将 JavaScript 应用程序部署到托管服务器。重要提示:存档必须仅包含应用程序源文件,而不是构建输出,跳过 node_modules 目录;如果存在 .gitignore 文件,还要排除其匹配的所有文件。存档上传后,服务器上将自动触发构建过程。上传凭据是生成并在内部使用的——不要调用单独的 upload-url 端点或自行上传存档,此工具端到端完成此操作。部署后,使用 hosting_list-js-deployments 工具检查部署状态并跟踪构建进度。
- 方法:
custom - 路径:
custom
hosting_deploy-static-website
从存档文件将静态网站部署到托管服务器。重要提示:此工具仅适用于没有构建过程的静态网站。存档必须包含准备好提供服务的预构建静态文件(HTML、CSS、JavaScript、图像等)。如果网站有 package.json 文件或需要构建命令,请改用 hosting_deploy-js-application。此工具通过 TUS 将存档上传到网站的文件浏览器并触发部署;存档被解压并直接部署,无需任何构建步骤。上传凭据是生成并在内部使用的——不要调用单独的 upload-url 端点或自行上传存档,此工具端到端完成此操作。用户名将根据域名自动解析。
- 方法:
custom - 路径:
custom
hosting_list-js-deployments
列出 JavaScript 应用程序部署以检查其状态。当客户询问部署状态时,请使用此工具。此工具检索域名的 Node.js 应用程序部署的分页列表,并可选择按部署状态进行过滤。
- 方法:
custom - 路径:
custom
hosting_show-js-deployment-logs
检索指定 JavaScript 应用程序部署的日志,以便在失败时进行调试。
- 方法:
custom - 路径:
custom
hosting_cache_clear-website
一次性永久清除网站的所有服务器端缓存。当内容已更新且需要立即可见时,或在做出重大更改后使用。
当网站启用 CDN 时,也会清除 Hostinger CDN 缓存。对于位于子目录中的 WordPress 安装,请传递目录查询参数以清除其缓存。
- 方法:
DELETE - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/cache/clear
hosting_cache_toggle-cacheless
根据 enabled 标志打开或关闭开发(无缓存)模式。启用时,不缓存任何内容,有效地关闭网站的所有缓存;在积极开发、测试更改、调试问题或需要实时更新可见时使用。完成开发工作后禁用此模式,以恢复缓存的性能优势。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/cacheless-mode/toggle
hosting_cache_toggle-website
根据 enabled 标志打开或关闭网站的服务器端缓存。启用它以加快页面加载、减少服务器负载并改善用户体验;推荐用于生产网站。禁用可能会影响性能;要在开发或调试时临时绕过缓存,建议切换无缓存模式。
如果缓存已处于请求的状态,则不执行任何操作。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/cache/toggle
hosting_cron-jobs_list
返回为指定账户配置的 cron 作业列表,包括其计划和命令。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/cron-jobs
hosting_cron-jobs_create
根据计划表达式和命令为指定账户创建 cron 作业。
返回创建的 cron 作业,包括其 uid,删除 cron 作业或获取其输出需要该 uid。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/cron-jobs
hosting_cron-jobs_delete
永久删除由其 uid 标识的 cron 作业。
uid 由列出 cron 作业的端点返回。
- 方法:
DELETE - 路径:
/api/hosting/v1/accounts/{username}/cron-jobs/{uid}
hosting_cron-jobs_output
返回由其 uid 标识的 cron 作业上次执行捕获的输出。
uid 由列出 cron 作业的端点返回。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/cron-jobs/{uid}/output
hosting_databases_change-password
更改指定数据库用户的密码。
数据库名称必须是列出数据库端点返回的完整名称。\n 密码还必须在使用此数据库的任何网站配置中更新。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/databases/{name}/change-password
hosting_databases_list
返回指定账户的数据库分页列表。
使用 domain 和 is_assigned 过滤器查找分配给特定域的数据库。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/databases
hosting_databases_create
为指定账户创建具有数据库用户和密码的数据库。
数据库名称和用户必要时会自动添加账户用户名作为前缀。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/databases
hosting_databases_delete
永久删除数据库及其远程连接。
数据库名称必须是列出数据库端点返回的完整名称。
- 方法:
DELETE - 路径:
/api/hosting/v1/accounts/{username}/databases/{name}
hosting_databases_create-remote-connection
允许远程主机连接到指定数据库。
提供 IPv4/IPv6 地址,或使用“%”允许任何主机。数据库名称必须是列出数据库端点返回的完整名称。数据库创建是同步的,因此此处的 404 表示该用户名下不存在该名称的数据库,而不是仍在创建中。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/databases/{name}/remote-connections
hosting_databases_delete-remote-connection
永久移除一条远程访问规则,撤销指定主机对数据库的远程访问权限。
使用必需的 ip 查询参数(IPv4/IPv6 地址,或 %,与列出远程连接端点返回的完全一致)来标识该规则。数据库名称必须是列出数据库端点返回的完整名称。
- 方法:
DELETE - 路径:
/api/hosting/v1/accounts/{username}/databases/{name}/remote-connections
hosting_databases_list-remote-connections
返回指定账户的远程访问规则:允许连接到账户数据库的远程主机(IPv4/IPv6 地址,或 % 表示任意主机)。
使用域名过滤器,仅返回分配给特定域名的数据库的规则。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/databases/remote-connections
hosting_databases_repair
异步修复损坏的数据库表。
当报告数据库错误、崩溃或损坏时使用。数据库名称必须是列出数据库端点返回的完整名称。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/databases/{name}/repair
hosting_databases_setup-website
为网站创建新的 MySQL 数据库,并将其连接信息写入网站的环境变量,然后重启应用程序。平台会生成密码(以及数据库名称和用户,除非另行提供)。密码永远不会返回;应用程序从环境中读取。
写入的变量:DB_HOST、DB_PORT、DB_NAME、DB_USER、DB_PASSWORD 和 DATABASE_URL(mysql://user:password@host:port/name、用户和密码经过百分号编码)。现有变量会被保留。如果网站已有任何同名变量,调用将失败并返回 422,且不会创建任何内容;Replace Node.js environment variables 端点可移除这些变量。
此调用后,这些变量就是普通的环境变量:Replace Node.js environment variables 端点可以像其他变量一样更改或移除它们。
对于在进程启动时读取环境变量的应用(如 Express 或 NestJS),重启即可。将变量烘焙到构建输出中的框架(Next.js、NEXT_PUBLIC_*)只有在全新构建(Start Node.js build 端点)后才能看到新值。
请求中的密码会被忽略;平台始终会生成密码。可选的 name 和 user 是标识符,而非机密信息。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/databases/setup
hosting_databases_phpmyadmin-link
返回指定数据库的 phpMyAdmin 直接登录链接。
当需要可视化数据库界面进行 SQL 查询、导入、导出或表管理时使用。数据库名称必须是列出数据库端点返回的完整名称。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/databases/{name}/phpmyadmin-link
hosting_datacenters_list
根据可用的数据中心容量和您订单的托管计划,检索可用于设置托管计划的数据中心列表。列表中的第一项是最符合您特定订单要求的选项。
- 方法:
GET - 路径:
/api/hosting/v1/datacenters
hosting_domains_generate-free-subdomain
生成一个唯一的免费子域名,可用于托管服务,无需购买自定义域名。免费子域名让您可以立即开始使用托管服务,之后随时可以将自定义域名连接到您的网站。
- 方法:
POST - 路径:
/api/hosting/v1/domains/free-subdomains
hosting_domains_list-website-parked
检索所选网站下创建的所有停放域名或别名域名。
使用此端点检查特定网站的停放域名配置,包括分配给每个停放域名的父域名和根目录。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/parked-domains
hosting_domains_create-website-parked
为所选网站创建停放域名或别名域名。
提供要停放在网站上的域名或 IP 地址,使其提供与父域名相同的内容。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/parked-domains
hosting_domains_delete-website-parked
从所选网站删除现有的停放域名或别名域名。
使用此端点移除不再需要的停放域名。
- 方法:
DELETE - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/parked-domains/{parkedDomain}
hosting_domains_list-website-subdomains
检索所选网站下创建的所有子域名。
使用此端点检查特定网站的子域名配置,包括分配给每个子域名的父域名和根目录。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/subdomains
hosting_domains_create-website-subdomain
为所选网站创建新的子域名。
提供子域名前缀,并可选择提供自定义目录或网站公共目录作为子域名根目录。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/subdomains
hosting_domains_delete-website-subdomain
从所选网站删除现有的子域名。
使用此端点移除不再需要的子域名。
- 方法:
DELETE - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/subdomains/{subdomain}
hosting_domains_verify-ownership
验证单个域名的所有权并返回验证状态。
使用此端点检查域名是否可供您访问,然后再将其用于新网站。如果域名可访问,响应将包含 is_accessible: true。如果不可访问,请将给定的 TXT 记录添加到您域名的 DNS 记录中,然后重试验证。请注意,新的 TXT DNS 记录可能需要最多 10 分钟才能传播。
使用 Hostinger 的免费子域名(*.hostingersite.com)时,请跳过此验证。
- 方法:
POST - 路径:
/api/hosting/v1/domains/verify-ownership
hosting_files_generate-upload-url
生成带有身份验证凭据的文件浏览器上传 URL,用于将文件直接上传到网站的文件存储。
当网站仍在设置中(列出网站设置端点上的 status: running)时,此端点返回 409 并带有 Retry-After 标头:等待该秒数后重试,或轮询网站设置直到状态为 completed。
返回 url、auth_key 和 rest_auth_key。使用这些通过 TUS 可恢复上传协议(TUS 1.0.0)将文件上传到网站的 public_html 目录。在下面的每个请求中发送 X-Auth: {auth_key} 和 X-Auth-Rest: {rest_auth_key} 标头。
- 创建上传:
POST到{url}/{relative_file_path}?override=true,并带有标头upload-length: {file size in bytes}和upload-offset: 0。预期返回201 Created。 - 上传文件:将文件字节发送到同一位置(任何 TUS 1.0.0 客户端,或带有
upload-offset标头跟踪进度的PATCH请求),直到完成。
relative_file_path 是 public_html 内的目标路径,例如 app.zip。
除了 TUS 客户端,普通的 curl 也可以:
FILE=app.zip
SIZE=$(stat -f%z "$FILE") # stat -c%s on Linux
curl -i -X POST "{url}/${FILE}?override=true" \
-H "X-Auth: {auth_key}" \
-H "X-Auth-Rest: {rest_auth_key}" \
-H "Tus-Resumable: 1.0.0" \
-H "Upload-Length: ${SIZE}" \
-H "Upload-Offset: 0"
# -> 201 Created
curl -i -X PATCH "{url}/${FILE}?override=true" \
-H "X-Auth: {auth_key}" \
-H "X-Auth-Rest: {rest_auth_key}" \
-H "Tus-Resumable: 1.0.0" \
-H "Content-Type: application/offset+octet-stream" \
-H "Upload-Offset: 0" \
--data-binary "@${FILE}"
# -> 204 No Content, Upload-Offset response header equals SIZE when done
- 方法:
POST - 路径:
/api/hosting/v1/files/upload-urls
hosting_files_list-website-and-directories
列出网站文档根目录下的文件和目录。
使用 directory 浏览相对于文档根目录的子目录。符号链接条目会被列出,但绝不会被遍历或解析。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/domains/{domain}/files
hosting_files_website-content
获取单个文件的内容,相对于网站的文档根目录。
只读;拒绝符号链接、超大文件、非文本文件类型以及被识别为包含机密信息(例如凭据文件)的文件——这些都不会通过此端点返回。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/domains/{domain}/files/content
hosting_git_auto-deployment-settings
返回网站的 Git 自动部署设置:哪个仓库和分支部署到哪个目录,以及推送是否触发部署。is_enabled 为 false 时保留仓库链接但忽略推送。
当网站未配置自动部署时,每个字段均为 null。使用 Update Git auto-deployment settings 保存设置。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/git/auto-deployments/settings
hosting_git_update-auto-deployment-settings
创建或替换网站的 Git 自动部署设置:仓库、分支、文档根目录下要部署到的目录,以及 is_enabled。发送完整设置;is_enabled 默认为 true,directory 默认为文档根目录。installation_uuid 必须是来自 List Git installations 的安装,且属于与网站相同的客户。
对于 PHP 和静态网站,使用 is_enabled true 保存会立即部署该分支,之后每次推送到该分支都会再次部署。对于 Node.js 和 Website Builder 网站,保存不会克隆任何内容。在 Node.js 网站上,使用 source_type git 通过 Start Node.js build 启动首次部署;之后推送会使用为网站存储的构建设置触发新构建。
- 方法:
PUT - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/git/auto-deployments/settings
hosting_git_delete-auto-deployment-settings
移除网站的 Git 自动部署设置。已部署的文件保留在网站上;推送将停止部署,直到再次保存设置。即使未配置任何内容,也会成功。
- 方法:
DELETE - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/git/auto-deployments/settings
hosting_git_list-installations
列出客户已连接的 Git 提供商账户。除非 status 过滤器另有说明,否则仅返回状态为 active 的安装。
空列表表示客户没有活跃的安装。同时检查 status=suspended 和 status=pending。如果完全没有,则需要在 hPanel(网站、管理、高级、Git;或添加网站、Node.js Web 应用、导入 Git 仓库)中连接一次 Git 提供商(GitHub 或 GitLab);此端点随后会列出新的安装。
使用 uuid 作为 List Git installation repositories 的路径参数,以及作为 Start Node.js build 中的 installation_uuid,并带有 source_type git 和 Update Git auto-deployment settings。
- 方法:
GET - 路径:
/api/hosting/v1/git/installations
hosting_git_list-installation-repositories
列出 Git 安装可以访问的仓库,实时从提供商读取。适用于 github 和 gitlab 安装。使用活跃的安装:暂停或待处理的安装仍会被查询,调用会以提供商的任何响应失败。列表按提供商返回的顺序截取前 500 个仓库;当账户有更多仓库时,请直接指定仓库名称,而不是搜索此列表。
owner、name 和一个分支(default_branch 或其他分支)放入 source_options 的 Start Node.js build 或 Update Git auto-deployment settings。当安装不属于该客户时返回 404。每个 API 客户端每分钟限制 10 次调用(超过则返回 429)。
- 方法:
GET - 路径:
/api/hosting/v1/git/installations/{uuid}/repositories
hosting_git_deploy-website-repository
将 Git 仓库克隆到网站目录中,或再次拉取。空目录或缺失目录会克隆该分支。已包含此仓库和分支的目录会重置为其最后一次提交并拉取:服务器上对仓库跟踪文件的更改会被丢弃,未跟踪的文件会保留。包含其他文件(包括另一个仓库或此仓库的另一个分支)的目录会被拒绝。当仓库有 composer.json 时,composer install 会在克隆或拉取后运行。
调用会等待部署完成并返回其日志。is_success 为 false 表示 Git 或 composer 失败,日志会说明原因。当第一次调用仍在等待服务器时,对同一目录的第二次调用会被拒绝。如果请求超时,部署仍可能在服务器上完成;稍后使用相同的仓库和分支再次调用会进行拉取。
私有仓库需要使用 SSH URL 以及来自 Generate Git SSH key 的账户 Git SSH 密钥,
并将该密钥作为部署密钥添加到仓库中。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/git/repositories/deploy
hosting_git_list-website-repositories
列出与网站目录关联的 Git 仓库,包含
Deploy website Git repository 或 hPanel 的 Git 部分中的信息:每个仓库的克隆 URL、分支和目录。
克隆失败的仓库仍会保留在列表中;重新部署会重试克隆。GitHub
和 GitLab 的自动部署不会在此列出;请参阅 Get Git auto-deployment settings。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/git/repositories
hosting_git_ssh-public-key
返回托管账户的公共 SSH 密钥。Deploy website Git repository 使用此密钥通过 SSH 进行
克隆和拉取,因此只要将该密钥作为部署密钥添加到 Git 主机上的私有仓库中,
私有仓库即可正常工作。当账户尚无密钥时,public_key 为 null。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/git/ssh-key
hosting_git_generate-ssh-key
创建托管账户的 SSH 密钥对并返回公共密钥。当账户已有 密钥时,返回该密钥且不做更改。一个密钥服务于账户的所有网站;在部署私有仓库之前, 请将公共密钥作为部署密钥添加到该仓库。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/git/ssh-key
hosting_headless_submit-build-report
提交无头技能在运行结束时(包括提前 停止)写入的构建报告,以便 Hostinger 了解构建卡住的位置。每次调用发送一份报告, 将报告 JSON 作为请求体,且不做更改。仅在用户同意时才发送报告。
报告必须符合 report.schema.json v1;无效报告将返回 422 且不会被 存储。报告与已认证账户关联,因此请勿向其中添加账户详细信息。
- 方法:
POST - 路径:
/api/hosting/v1/headless/agent-reports
hosting_nodejs_list-builds
检索特定网站的 Node.js 构建进程的分页列表。
每个构建代表 Node.js 构建管道的一次运行。使用 states
查询参数按构建状态(pending、running、completed、failed)过滤结果。
使用构建中的 uuid 通过 Get Node.js Build Logs 端点轮询其输出。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds
hosting_nodejs_start-build
使用网站文件存储中已有的文件启动 Node.js 构建进程。
警告:成功时此操作会覆盖网站的现有内容,且无法 撤销——在调用此端点前请确认这是预期操作。
使用 source_type archive 时,source_options.archive_path 必须指向服务器上现有的
归档文件(相对于网站文档根目录)。请先使用
Generate Upload URL 端点获取凭据并上传归档文件。要在启动前从归档文件自动检测构建设置,
请先调用 Get Node.js Build Settings from Archive 端点。
使用 source_type git 时,source_options 携带 owner、repository、branch 和
installation_uuid。从 List Git installations 获取安装信息,从 List Git installation repositories 获取所有者和
仓库;分支将按其当前 head 克隆。安装必须与网站属于同一客户。
返回的构建 uuid 可用于通过
Get Node.js Build Logs 端点轮询进度和获取日志。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds
hosting_nodejs_build-settings
返回为网站存储的构建设置:框架(app_type)、Node.js 版本、
根目录和输出目录、构建脚本、入口文件和包管理器。存储的设置
驱动 Git 自动部署构建。通过 API 启动的构建使用该请求中发送的值,
并且仅当尚无设置时才将其保存于此。
在首次构建或首次设置更新存储它们之前,返回 404。在构建失败后使用此端点
检查框架或入口文件是否被错误检测,然后使用 Update Node.js build settings 端点修复它们。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/settings
hosting_nodejs_update-build-settings
替换为网站存储的构建设置。发送完整集合:node_version 是
必需的,并且您省略的每个可空字段都将存储为 null。当尚无设置时,将创建设置。
此操作不会启动构建。存储的设置驱动 Git 自动部署构建;通过 API 启动的构建
使用该请求中发送的值,因此要使用修正后的设置重新构建,请使用相同的值调用
Start Node.js build。典型修复:自动检测后错误的 app_type,
或缺少 express、fastify、nest、nuxt 和 hono 应用的 entry_file。
- 方法:
PUT - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/settings
hosting_nodejs_build-settings-from-archive
从服务器上已有归档内的 package.json 自动检测 Node.js 构建设置。
在调用 Start Node.js Build 之前使用此端点预览将使用的设置,
或让用户审查和覆盖值(框架、Node.js 版本、根目录、
输出目录、构建脚本),然后再提交构建。
归档必须已存在于网站的文件存储中。请先使用
Generate Upload URL 端点获取凭据并上传归档文件。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/settings/from-archive
hosting_nodejs_list-environment-variables
列出当前为网站设置的 Node.js 环境变量。值始终被掩码为
********,无法通过此 API 读回。使用此端点查看
配置了哪些键或验证更改,而不是读取值。
要更改变量,请使用 Replace Node.js environment variables 端点。它会替换
整个集合,因此切勿将来自此响应的掩码值复制到该请求中;请发送
完整的期望集合,并使用来自项目 .env 文件或用户提示的真实值。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/settings/env
hosting_nodejs_replace-environment-variables
将网站的 Node.js 环境变量替换为提供的变量。这是一个
完全替换:请求中不包含的任何变量都会被删除,发送空的 env_vars
数组将删除所有变量。保存会写入值并重启正在运行的 Node.js
进程。
对于在进程启动时读取环境变量的应用(如 Express 或 NestJS),重启就足够了。
对于将变量烘焙到构建中的框架则不够。Next.js standalone 就是其中之一:构建时值(包括
NEXT_PUBLIC_*)需要全新的构建。在此调用之后,使用 Start Node.js build 端点
以便这些应用获取新值。
List Node.js environment variables 端点返回掩码值(********),因此
切勿将来自它的值复制到此请求中。始终发送完整的期望集合,并使用来自项目
.env 文件或用户提示的真实值。
- 方法:
PUT - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/settings/env
hosting_nodejs_analyse-failed-build
基于构建日志、项目文件列表和 package.json,返回构建失败原因及修复方法的 AI 分析。
只有处于 failed 状态的构建可以被分析;
任何其他状态返回 422。当无法生成分析时,analysis 和
solution 均为 null,此时请阅读 Get NodeJS build logs。
每次调用都会重新运行分析,因此每个失败的构建调用一次并保留结果。 每个 API 客户端每分钟限制 5 次调用(超过则返回 429)。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/{uuid}/analysis
hosting_nodejs_build
按 UUID 返回一个构建:其状态(pending、running、completed、failed)、
运行时的选项和时间戳。在构建处于 pending 或 running 状态时轮询此端点。当
构建失败时,阅读 Get NodeJS build logs 和 Analyse failed Node.js build 以了解原因。
当 UUID 不属于此网站的构建时,返回 404。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/{uuid}
hosting_nodejs_build-logs
从特定的 Node.js 构建进程检索日志。
要在构建运行时流式传输实时输出,请在构建状态为 running 时
重复轮询此端点,将先前返回的 lines 计数作为
from_line 传递,以仅获取自上次调用以来的新输出。
日志内容可能包含 ANSI 转义序列(颜色代码)。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/{uuid}/logs
hosting_nodejs_runtime-logs
返回 Node.js 应用程序的运行时控制台日志条目,最旧的在前,每个条目包含
时间戳、级别和消息。首次调用时发送 period(1h、1d、1w 或 1m)
以及可选的 levels 和 limit(1-5000,默认 1000);当匹配的条目多于
limit 时,保留最新的。
要轮询新条目,请将先前响应中的 total_lines + 1 作为 from_line 发送
并省略 period;period 和 from_line 不能组合。非 JSON 且
没有时间戳、级别和消息的行会被跳过,因此 logs 可能少于 limit
条目,而 total_lines 计数每个原始行。时间戳早于
last_deployed_at 的条目属于之前的部署。当应用程序尚未写入日志文件时,
返回空的 logs 列表。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/runtime-logs
hosting_nodejs_clear-runtime-logs
清空 Node.js 应用程序的运行时日志文件。此操作无法撤销,因此在调用前 请与用户确认。即使日志文件尚不存在,也返回成功。
在重现问题之前使用它,以便下一次 Get Node.js runtime logs 调用返回
仅包含新条目;从 period 重新开始该调用,而不是重用清除前的 from_line。
- 方法:
DELETE - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/runtime-logs
hosting_nodejs_restart-application
重启网站的 Node.js 服务器进程。不会重新构建或重新部署 应用程序。使用它来应用环境或配置更改,或恢复挂起的 应用程序。
仅适用于服务器端应用程序(Express、Next.js、NestJS 等)。静态 前端应用(React、Vue、Vite)没有持久的服务器进程,因此重启它们 没有效果。即使网站没有可重启的服务器进程,也返回成功。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/server/restart
hosting_nodejs_list-vulnerabilities
列出在 Node.js 网站上检测到的已知 npm 包漏洞,并附带
公告元数据(严重性、CVSS 分数、CVE、公告 URL)。结果按
严重性从高到低排序,然后按发布日期(最新的在前)。使用
severities 查询参数进行过滤。
is_patchable 设置为 true 的漏洞可以通过
Patch Node.js Vulnerabilities 端点自动修复,该端点会打开一个包含
更新包版本的 GitHub 拉取请求。自动修复仅适用于从
连接的 GitHub 仓库部署的网站。is_patching_in_progress 设置为
true 的漏洞已包含在打开的补丁拉取请求中;当任何补丁拉取
请求处于打开状态时,对此网站的新补丁请求将被拒绝,直到该请求被合并
或关闭。
数据来自定期依赖扫描,因此可能滞后于最新部署。 空列表意味着最近的扫描未发现漏洞;它不 保证当前部署没有漏洞。适用于商业和 云托管计划。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/vulnerabilities
hosting_nodejs_patch-vulnerabilities
修补所选 Node.js 漏洞,方法是更新 package.json 中受影响的软件包版本,并在已连接的仓库中打开一个 GitHub 拉取请求。客户审阅并合并该拉取请求;合并会触发自动部署。
自动修复仅适用于从已连接的 GitHub 仓库部署的网站。从归档部署的网站没有自动修复路径,并返回 404。Hostinger GitHub 应用需要对仓库具有写入权限;否则请求会失败并返回 403,说明缺少该权限。
只有 is_patchable 设置为 true 的漏洞才能被修补。所选内容中不可修补的 ID 会被跳过;拉取请求涵盖可修补的子集,列在 patched_vulnerability_ids 中。没有任何可修补漏洞的所选内容会被拒绝并返回 422。每个网站同一时间只能有一个修补拉取请求处于打开状态;在再次修补之前请关闭或合并它。适用于商业版和云托管套餐。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/vulnerabilities/patch
hosting_websites_list-setups
返回经过身份验证的客户端可访问的托管账户在过去 24 小时内启动的网站设置,最新的在前。使用 order_id、subscription_id 或 domain 过滤器来缩小列表范围。
用于在创建网站或启动网站设置后立即进行轮询:网站在其服务器端设置完成之前就会出现在网站列表中,而当设置为 running 时,操作该网站的端点可能会以 404 或 409 响应。使用 domain 过滤器每 10 到 15 秒轮询此端点,并等待 status: completed 后再上传文件、部署或创建数据库。failed 表示设置在完成前已停止,或超过一小时未报告进度。超过 24 小时的设置不会列出。
type 是设置启动时的网站类型(wordpress、headless_wordpress、headless_ecommerce、headless_pocketbase),对于空网站则为 null。
- 方法:
GET - 路径:
/api/hosting/v1/onboardings
hosting_websites_start-setup
在 Web 或云托管订单上启动网站设置,并立即返回创建的设置;网站本身是异步配置的。使用 domain 过滤器每 10 到 15 秒轮询列表网站设置端点,并等待 status: completed 后再上传文件、部署或创建数据库。
对于空网站,省略 type。type: wordpress 会在网站根目录安装 WordPress,使用 wordpress 中的管理员用户、电子邮件和密码,域名作为站点标题,并在省略 wordpress.language 时使用 en_US。无头类型(headless_wordpress、headless_ecommerce、headless_pocketbase)会创建无头网站;headless_wordpress 还会在网站根目录的 cms 目录中安装 WordPress,并使用生成的凭据。
省略 domain 可在生成的临时免费子域上设置网站。
当订单还没有托管账户时,设置会先创建一个,位于 datacenter_code 指定的数据中心,或省略时使用订单的默认数据中心。当订单不存在或经过身份验证的客户端无法访问时返回 404,当同一域名的设置仍在运行时返回 409 并带有 Retry-After 标头。
- 方法:
POST - 路径:
/api/hosting/v1/orders/{order_id}/onboardings
hosting_orders_list
检索经过身份验证的客户端可访问的订单分页列表。
仅列出 Web 和云托管订单。代理计划订单由 GET /api/agency-hosting/v1/orders 列出。
此端点返回您的托管账户的订单,以及与您共享访问权限的其他客户端托管账户的订单。
使用可用的查询参数按订单状态或特定订单 ID 过滤结果,以获得更有针对性的结果。
- 方法:
GET - 路径:
/api/hosting/v1/orders
hosting_php_reset-extensions
将网站的所有 PHP 扩展重置为其默认状态。
用于从扩展冲突中恢复或恢复原始配置。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/extensions/reset
hosting_php_get
返回网站的完整 PHP 配置:当前版本、可用版本(受支持和不受支持)、启用/禁用的扩展、带有当前值、默认值、类型和套餐限制(max)的选项,以及冲突的扩展组。
用于在更新版本、扩展或选项之前检查当前的 PHP 设置。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/details
hosting_php_info
返回网站的完整 phpinfo 页面(HTML)。
用于调试 PHP 问题或检查网站的完整 PHP 环境。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/php-info
hosting_php_update-extensions
启用或禁用网站的 PHP 扩展(模块)。
在更改之前,使用获取 PHP 详细信息端点检查当前的扩展状态。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/extensions
hosting_php_update-options
更新网站的 PHP 选项(例如 memory_limit、max_execution_time、upload_max_filesize)。仅在 options 对象中提供您想要更改的选项。
高于账户套餐限制的值会被静默限制到该限制,因此请求可以成功但应用的值较小。之后调用获取 PHP 详细信息端点以读取应用的值。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/options
hosting_php_update-version
更改网站的 PHP 版本。
使用获取 PHP 详细信息端点查看网站可用的版本。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/version
hosting_redirects_list-website
返回为所选网站配置的重定向分页列表。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/redirects
hosting_redirects_create-website
创建从所选网站上的 URL 到另一个 URL 或 IP 地址的重定向。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/redirects
hosting_redirects_delete-website
永久删除由其源 URL 标识的重定向。
传递 from 值,完全按照列表重定向端点返回的值。
- 方法:
DELETE - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/redirects
hosting_ssl_install
为网站请求终身 SSL 证书。安装会在后台运行;Get SSL status 在结束时报告 active 或 failed。active 终身证书不会阻止请求:会请求新的安装,这就是证书重新安装的方式。
对于免费子域返回 422(其证书由平台管理),当安装处于 installing 或 waiting_for_retry 时,当网站的证书已被吊销(无法重新签发)时,以及当安装了上传的自定义证书时;必须先卸载该证书。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/ssl/setup
hosting_ssl_status
返回网站的 SSL 状态:证书 status 和 provider,证书是否是由平台管理的终身证书,HTTP 请求是否重定向到 HTTPS,证书何时停止有效,以及最后一次安装错误。
installing 和 waiting_for_retry 表示安装正在进行中。failed 表示最后一次安装放弃,或网站在 installing 时 60 分钟未更新;last_error 在是已知消息时包含原因,否则为 null。expired 表示分配的证书的有效期已结束。not_installed 表示未分配证书。免费子域使用平台管理的证书:没有安装记录时,它们报告 active,其中 provider 和 expires_at 为 null。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/ssl/status
hosting_ssl_toggle-https-redirect
根据 is_enabled 打开或关闭网站的 HTTP 到 HTTPS 重定向。当重定向已处于请求状态时不执行任何操作。打开它需要已安装的证书(status active 或 expired 在 Get SSL status 上),如果没有则返回 422;关闭它始终被接受。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/ssl/https-redirect/toggle
hosting_ssl_uninstall
移除分配给网站的 SSL 证书,关闭 HTTPS 重定向,并取消待处理的安装重试。网站提供纯 HTTP 服务,直到新的安装完成。Get SSL status 在调用返回时立即报告 not_installed;即使未分配证书,调用也会成功,因此重复调用是安全的。
对于免费子域返回 422(其证书由平台管理),并且当安装处于 installing 时。
- 方法:
DELETE - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/ssl
hosting_websites_list
检索经过身份验证的客户端可访问的网站(CloudLinux、Builder 和 Horizons)的分页列表。
此端点返回您的托管账户的网站,以及与您共享访问权限的其他客户端托管账户的网站。
每个网站都包含一个 website_type 字段,描述在底层平台上检测到的网站类型(wordpress、builder、horizons、nodejs 或 other)。某些字段,如 vhost_type、username 和 root_directory,仅适用于 CloudLinux 网站,对于其他平台为 null。
使用 website_types 仅列出给定检测类型的网站,例如仅 WordPress 网站(website_types=wordpress)或仅 Node.js 网站(website_types=nodejs)。与其他可用的查询参数组合,按用户名、订单 ID、启用状态或域名过滤,以获得更有针对性的结果。
网站在其服务器端设置完成之前就会出现在此列表中,is_enabled 反映的是暂停状态,而不是就绪状态。要了解新创建的网站何时准备好进行文件、部署或数据库操作,请改为轮询列表网站设置端点。
- 方法:
GET - 路径:
/api/hosting/v1/websites
hosting_websites_create
已弃用:请改用 POST /api/hosting/v1/orders/{order_id}/onboardings(启动网站设置)。它接受相同的 domain 和 datacenter_code,也可以安装 WordPress,并返回创建的设置。
为经过身份验证的客户端创建新网站。
您必须选择要在哪个托管订单上创建此网站。将该订单作为 order_id 与域名一起传递。列出订单以查看可用的 ID;网站将在该订单的托管套餐上配置。
仅接受 Web 和云托管订单。要在代理计划订单上创建网站,请使用 POST /api/agency-hosting/v1/orders/{order_id}/websites/setups。
当订单还没有托管账户时,会先创建一个新的托管账户,位于 datacenter_code 指定的数据中心,或省略时使用订单的默认数据中心。后续网站将自动托管在同一数据中心。
网站创建是异步的,最多需要几分钟。使用 domain 过滤器每 10 到 15 秒轮询列表网站设置端点,并等待 status: completed 后再上传文件、部署或创建数据库。当设置为 running 时,操作该网站的端点可能会以 404 或 409 响应。网站列表上的 is_enabled 反映的是暂停状态,而不是就绪状态。
- 方法:
POST - 路径:
/api/hosting/v1/websites
hosting_websites_deploy-static-site-archive
从归档文件部署静态应用。
警告:此操作会覆盖网站现有内容且无法撤销——在调用此端点前,请确认这是预期操作。
此端点允许您从已上传到网站目录的归档文件部署静态应用。
此功能仅适用于静态站点(预构建的 HTML/CSS/JS,无需构建步骤)。对于 Node.js 应用,请改用 Create NodeJS build from archive,如果归档文件已上传,则使用 Start Node.js build。对于 WordPress 站点,请使用 Import WordPress website。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/deploy
hosting_websites_delete
此端点会永久删除网站及其所有数据。此操作无法撤销。在调用之前,请确保用户理解后果并明确确认要继续。
所有网站文件、数据库及相关配置都将被移除。托管套餐本身会保留,因此之后可以在其上创建新网站。
支持的网站:Web 托管套餐上的主域名和附加域名网站,以及 Website Builder 网站。停放域名和子域名无法通过此端点删除。域名必须是确切的网站域名,不能是预览域名或别名。
当域名不存在或不属于已认证客户端时,返回 404。
网站移除是异步处理的,可能需要几分钟才能完成。响应会在移除完成前返回。
- 方法:
DELETE - 路径:
/api/hosting/v1/websites/{domain}
hostinger-mail-mcp
mail_aliases_create-alias
为指定邮箱创建别名。别名地址由给定的本地部分和邮箱的域名组成。发送到别名的邮件将投递到该邮箱。
- 方法:
POST - 路径:
/api/mail/v1/mailboxes/{mailboxId}/aliases
mail_aliases_delete-alias
删除别名。发送到别名地址的邮件将不再投递到该邮箱。
- 方法:
DELETE - 路径:
/api/mail/v1/aliases/{aliasId}
mail_aliases_list
检索邮件订单中所有邮箱的别名分页列表。
- 方法:
GET - 路径:
/api/mail/v1/orders/{orderId}/aliases
mail_api-tokens_create
为指定邮件订单创建 API 令牌。该令牌授予对 Hostinger Email API 的访问权限,您可以在其中配置和管理其作用域内的邮箱。
明文令牌仅在此响应中返回,之后不再显示。每个订单最多可存在 10 个令牌。使用 scope.has_all_mailboxes 覆盖所有当前和未来的邮箱,或在 scope.mailbox_ids 中列出特定邮箱。
- 方法:
POST - 路径:
/api/mail/v1/orders/{orderId}/api-tokens
mail_api-tokens_revoke
撤销 API 令牌。令牌立即失去对 Hostinger Email API 的访问权限。此操作无法撤销。
- 方法:
DELETE - 路径:
/api/mail/v1/api-tokens/{tokenId}
mail_api-tokens_list
检索所有邮件订单中 Hostinger Email API 令牌的分页列表,可选按订单筛选。明文令牌永远不会包含在内;它们仅在创建令牌时返回。
- 方法:
GET - 路径:
/api/mail/v1/api-tokens
mail_autoreplies_create
为指定邮箱创建自动回复。一个邮箱只能有一个自动回复。省略 starts_at 可立即激活自动回复,省略 ends_at 可使其无限期保持激活状态。
- 方法:
POST - 路径:
/api/mail/v1/mailboxes/{mailboxId}/autoreplies
mail_autoreplies_update
用给定的内容和计划替换自动回复。省略的可选字段将被清除:省略 starts_at 可立即激活自动回复,省略 ends_at 可使其无限期保持激活状态。
- 方法:
PUT - 路径:
/api/mail/v1/autoreplies/{autoreplyId}
mail_autoreplies_delete
删除邮箱的自动回复。邮箱将立即停止发送自动回复。
- 方法:
DELETE - 路径:
/api/mail/v1/autoreplies/{autoreplyId}
mail_autoreplies_list
检索邮件订单中所有邮箱的自动回复分页列表。
- 方法:
GET - 路径:
/api/mail/v1/orders/{orderId}/autoreplies
mail_catchalls_create-catch-all
创建通配邮箱,将所有发送到域名未知地址的邮件路由到指定邮箱。该邮箱地址会收到确认邮件,通配邮箱仅在确认后才会激活。一个域名只能有一个通配邮箱。
- 方法:
POST - 路径:
/api/mail/v1/mailboxes/{mailboxId}/catchalls
mail_catchalls_delete-catch-all
删除通配邮箱。发送到域名未知地址的邮件将不再路由到该邮箱。
- 方法:
DELETE - 路径:
/api/mail/v1/catchalls/{catchallId}
mail_catchalls_list-catch-alls
检索邮件订单中所有邮箱的通配邮箱分页列表。
- 方法:
GET - 路径:
/api/mail/v1/orders/{orderId}/catchalls
mail_catchalls_resend-catch-all-confirmation
向未确认通配邮箱的邮箱地址重新发送确认邮件。
- 方法:
POST - 路径:
/api/mail/v1/catchalls/{catchallId}/confirmation/resend
mail_forwarders_create
从指定邮箱创建转发器到目标地址。目标地址会收到确认邮件,转发仅在确认后才会激活。
- 方法:
POST - 路径:
/api/mail/v1/mailboxes/{mailboxId}/forwarders
mail_forwarders_delete
删除转发器。邮箱将立即停止向目标地址转发邮件。
- 方法:
DELETE - 路径:
/api/mail/v1/forwarders/{forwarderId}
mail_forwarders_list
检索邮件订单中所有邮箱的转发器分页列表。
- 方法:
GET - 路径:
/api/mail/v1/orders/{orderId}/forwarders
mail_forwarders_resend-confirmation
向未确认转发器的目标地址重新发送确认邮件。
- 方法:
POST - 路径:
/api/mail/v1/forwarders/{forwarderId}/confirmation/resend
mail_forwarders_update-keep-copy-setting
启用或禁用保留邮箱中转发邮件的副本。
- 方法:
PATCH - 路径:
/api/mail/v1/forwarders/{forwarderId}/keep-copy
mail_logs_list-access
检索指定邮件订单所附加域名的分页访问日志。支持按账户、日期范围、协议、状态和删除标志筛选。结果按时间戳降序排序。
- 方法:
GET - 路径:
/api/mail/v1/orders/{orderId}/logs/access
mail_logs_list-action
检索指定邮件订单的分页账户操作日志(管理和用户操作)。支持按账户、日期范围和状态筛选。结果按时间戳降序排序。
- 方法:
GET - 路径:
/api/mail/v1/orders/{orderId}/logs/action
mail_logs_list-inbound
检索指定邮件订单所附加域名的分页入站(收到的邮件)投递日志。支持按账户、日期范围、状态、发件人和收件人筛选。结果按时间戳降序排序。
- 方法:
GET - 路径:
/api/mail/v1/orders/{orderId}/logs/inbound
mail_logs_list-mailbox-action
检索指定邮件订单中邮箱的分页邮箱操作日志(邮件和邮箱事件)。邮箱地址必须属于订单的域名。支持日期范围和事件类型筛选。结果按时间戳降序排序。
- 方法:
GET - 路径:
/api/mail/v1/orders/{orderId}/logs/mailbox-actions
mail_logs_list-outbound
检索指定邮件订单所附加域名的分页出站(发送的邮件)投递日志。支持按账户、日期范围、状态、发件人和收件人筛选。结果按时间戳降序排序。
- 方法:
GET - 路径:
/api/mail/v1/orders/{orderId}/logs/outbound
mail_mailboxes_list
检索属于邮件订单的邮箱分页列表。
使用此端点监控邮件服务的邮箱,包括其状态、启用的协议、附加的资源数量以及定期同步的使用数据(使用数据可能滞后于实时值)。
- 方法:
GET - 路径:
/api/mail/v1/orders/{orderId}/mailboxes
mail_mailboxes_create-mailbox
在指定邮件订单下创建邮箱。完整电子邮件地址由给定的本地部分和订单的域名组成。
- 方法:
POST - 路径:
/api/mail/v1/orders/{orderId}/mailboxes
mail_mailboxes_delete-mailbox
删除邮箱。邮箱将被软删除,并在有限时间内可恢复,之后将被永久移除。
- 方法:
DELETE - 路径:
/api/mail/v1/mailboxes/{mailboxId}
mail_mailboxes_change-mailbox-password
更改邮箱的密码。
- 方法:
PATCH - 路径:
/api/mail/v1/mailboxes/{mailboxId}/password
mail_orders_list
检索与您的账户关联的邮件订单分页列表。
使用此端点监控您的邮件服务,包括其状态、套餐、附加域名和到期详情。
- 方法:
GET - 路径:
/api/mail/v1/orders
mail_orders_plan
检索指定邮件订单购买时的套餐,包括域名级和邮箱级的配额、限制和协议可用性。
- 方法:
GET - 路径:
/api/mail/v1/orders/{orderId}/plan
mail_webhooks_create
为指定邮箱创建 Webhook。生成的密钥仅在此响应中返回,并作为 Bearer 令牌随每次投递发送。
- 方法:
POST - 路径:
/api/mail/v1/mailboxes/{mailboxId}/webhooks
mail_webhooks_list-delivery-logs
检索指定邮件订单的 Webhook 投递日志分页列表,包括投递结果、持续时间和重试次数。支持按邮箱筛选。
- 方法:
GET - 路径:
/api/mail/v1/orders/{orderId}/webhooks/delivery-logs
mail_webhooks_get
检索单个 Webhook 的详细信息。Webhook 密钥永远不会包含在内;它仅在创建 Webhook 或重新生成密钥时返回。
- 方法:
GET - 路径:
/api/mail/v1/webhooks/{webhookId}
mail_webhooks_delete
永久删除 Webhook。此操作无法撤销。删除后,URL 将不再接收事件通知。
- 方法:
DELETE - 路径:
/api/mail/v1/webhooks/{webhookId}
mail_webhooks_update
部分更新 Webhook。仅更改请求体中包含的字段;省略的字段保留其当前值。传递 "description": null 以清除描述。
- 方法:
PATCH - 路径:
/api/mail/v1/webhooks/{webhookId}
mail_webhooks_list
检索属于指定邮件订单的 Webhook 分页列表。支持按邮箱和状态筛选。Webhook 密钥永远不会包含在内;它仅在创建 Webhook 或重新生成密钥时返回。
- 方法:
GET - 路径:
/api/mail/v1/orders/{orderId}/webhooks
mail_webhooks_regenerate-secret
重新生成 Webhook 的密钥。之前的密钥将立即失效。新密钥仅在此响应中返回,并作为 Bearer 令牌随每次投递发送。
- 方法:
POST - 路径:
/api/mail/v1/webhooks/{webhookId}/regenerate-secret
mail_webhooks_test
向 Webhook URL 发送测试投递并返回结果。测试请求在上游受到速率限制。
- 方法:
POST - 路径:
/api/mail/v1/webhooks/{webhookId}/test
hostinger-reach-mcp
reach_automations_get
获取单个自动化,包括进入、正在流转、完成或中途失败的联系人数量。
这描述了自动化本身。要查看其运行的工作流,请使用步骤端点。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}
reach_automations_list
获取配置文件中自动化的分页列表。
每个自动化都附带进入、正在流转、完成或中途失败的联系人数量。这些数量描述的是联系人旅程,而非邮件互动指标——如需查看打开、点击和退订数据,请改用活动统计端点。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/automations
reach_automations_list-steps
获取自动化的工作流,以步骤的扁平列表形式返回。
这些步骤构成树形结构而非直线:请遵循 parent_uuid 来重建分支,并使用 step_order 对共享父级的步骤进行排序。尚无步骤的自动化将返回空列表。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}/steps
reach_campaigns_get
获取单个营销活动,包括其发件人、主题、模板引用、目标受众和投递进度。
这描述了营销活动是如何设置的以及进展到何种程度。如需查看打开、点击和退订数据,请使用营销活动统计端点。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}
reach_campaigns_list
获取某个配置文件中营销活动的分页列表。
每个营销活动都带有其核心参与率。按状态筛选可查找草稿、已计划、发送中或已发送的营销活动,请注意,完全发送的营销活动状态为 publish。默认仅返回常规营销活动——传入 type 可获取自动化发送的邮件或双重选择加入确认邮件。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/campaigns
reach_campaigns_create-draft
在配置文件中创建营销活动。
营销活动以草稿形式创建,因此不会发送任何内容,也不会接触任何联系人。它也没有受众——目标定位和计划安排不属于此请求的一部分,草稿将在 Reach 界面中完成并发送。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/campaigns
reach_campaigns_performance
获取营销活动的表现:投递、打开、点击和退订,以及相应的比率。
每个计数都是独立联系人而非原始事件,因此同一联系人打开同一封邮件五次只计一次。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics
reach_contacts_delete
删除具有指定 UUID 的联系人。
此端点会从电子邮件营销系统中永久移除联系人。
已弃用。 此端点无法指定配置文件,因此始终回退到客户端的默认配置文件,无法删除任何其他配置文件的联系人。请改用 DELETE /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}。
- 方法:
DELETE - 路径:
/api/reach/v1/contacts/{uuid}
reach_contact-fields_delete
删除自定义联系人字段。
联系人持有的该字段的所有值都会随之删除,对于选择类型,其选项也会一并删除。联系人本身不受影响。
- 方法:
DELETE - 路径:
/api/reach/v1/profiles/{profileUuid}/contacts/fields/{fieldUuid}
reach_contact-fields_update
重命名自定义联系人字段,对于选择类型,替换其选项集。
带有 uuid 的选项会被保留并重新标记,没有 uuid 的选项会被创建,而列表中遗漏的任何现有选项将被删除,同时删除联系人持有的相应值。字段类型和别名无法更改。
- 方法:
PATCH - 路径:
/api/reach/v1/profiles/{profileUuid}/contacts/fields/{fieldUuid}
reach_contact-fields_list
获取配置文件中定义的自定义联系人字段。
自定义字段允许您在联系人上存储自己的属性。返回的 uuid 是您传递给联系人更新端点以设置值的标识,选择字段还会列出可供选择的选项。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/contacts/fields
reach_contact-fields_create
在配置文件中定义新的自定义联系人字段。
slug 由标签派生而来,与字段类型一样,之后无法更改。使用返回的 uuid 在联系人上设置值。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/contacts/fields
reach_contacts_list-groups
获取所有联系人分组的列表。
此端点返回可用于组织联系人的联系人分组列表。
- 方法:
GET - 路径:
/api/reach/v1/contacts/groups
reach_contacts_list
获取联系人列表,可选择按分组和订阅状态筛选。
此端点返回带有基本信息的联系人分页列表。您可以按分组 UUID 和订阅状态筛选联系人。
已弃用。 此端点无法指定配置文件,因此始终回退到客户端的默认配置文件,无法列出任何其他配置文件的联系人。请改用 GET /api/reach/v1/profiles/{profileUuid}/contacts,它还将分组筛选替换为标签筛选。
- 方法:
GET - 路径:
/api/reach/v1/contacts
reach_contacts_create
在电子邮件营销系统中创建新联系人。
此端点允许您使用姓名、电子邮件和姓氏等基本信息创建新联系人。
如果启用了双重选择加入,联系人将以待处理状态创建,并会发送确认邮件。
- 方法:
POST - 路径:
/api/reach/v1/contacts
reach_contacts_get
获取单个联系人的完整详细信息。
除了联系人自身的属性外,此端点还返回分配给它的标签以及它持有的配置文件自定义联系人字段的值。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}
reach_contacts_delete-profile
从配置文件中永久删除联系人。
联系人将连同其自定义字段值和标签分配一起被移除。
- 方法:
DELETE - 路径:
/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}
reach_contacts_update
更新联系人的属性和自定义字段值。
只有请求体中存在的属性才会被更改,因此部分请求体足以更改单个属性。将属性发送为 null 会清除该属性。
响应包含联系人的核心属性。使用 GET /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid} 读回其标签、自定义字段值、来源和备注。
- 方法:
PATCH - 路径:
/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}
reach_contacts_create-in-bulk
在单次调用中在配置文件中创建多个联系人。
联系人在后台导入,因此成功响应意味着导入已被接受而非已完成。配置文件中已存在相同电子邮件的联系人将保持不变。如果启用了双重选择加入,新联系人将以待处理状态开始,并会发送确认邮件。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/contacts/bulk
reach_contacts_list-profile
获取属于某个配置文件的联系人的分页列表。
联系人可以按订阅状态、标签和电子邮件搜索词进行筛选。响应的 meta.total 字段是匹配筛选条件的联系人数量,因此不带筛选条件调用此端点即可获得配置文件的联系人总数。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/contacts
reach_contacts_create-bulk
在电子邮件营销系统中创建新联系人。
此端点允许您使用姓名、电子邮件和姓氏等基本信息创建新联系人。
如果启用了双重选择加入,联系人将以待处理状态创建,并会发送确认邮件。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/contacts
reach_segments_list
获取所有联系人分段的列表。
此端点返回可用于组织联系人的联系人分段列表。
已弃用。 此端点无法指定配置文件,因此始终回退到客户端的默认配置文件,无法列出任何其他配置文件的分段。请改用 GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments。
- 方法:
GET - 路径:
/api/reach/v1/segmentation/segments
reach_segments_create
创建新的联系人分段。
此端点允许创建可用于组织联系人的新联系人分段。分段可以配置特定条件,如电子邮件、姓名、订阅状态等。
已弃用。 此端点无法指定配置文件,因此始终回退到客户端的默认配置文件,无法在任何其他配置文件中创建分段。请改用 POST /api/reach/v1/profiles/{profileUuid}/segmentation/segments。
- 方法:
POST - 路径:
/api/reach/v1/segmentation/segments
reach_segments_count-profile-contacts
统计当前匹配某个分段的联系人数量,而不列出它们。
当只需要数量时,这比分页浏览分段联系人端点更经济。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/count
reach_segments_list-profile-contacts
检索与特定配置文件下特定分段关联的联系人。
此端点允许您获取和筛选属于特定分段(由其 UUID 标识)的联系人,范围限定在特定配置文件内。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts
reach_segments_profile
获取配置文件中的单个分段,包括定义它的条件。
要检索当前匹配这些条件的联系人,请改用分段联系人端点。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}
reach_segments_update-profile
重命名分段和/或替换定义它的条件。
name 始终为必填项。省略 conditions 可仅重命名而不修改条件;提供条件则会完全替换现有条件集,而非合并。联系人永远不会被修改,但匹配该分段的联系人可能会立即发生变化。
- 方法:
PUT - 路径:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}
reach_segments_delete-profile
删除分段。
仅删除分段定义。匹配该分段的联系人保持不变。
- 方法:
DELETE - 路径:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}
reach_segments_list-filter-attributes
列出分段条件可以筛选的每个属性,包括每个属性接受的运算符、它们期望的值格式,以及当值受限时允许的值。
该列表是配置文件特定的:它包含配置文件的自定义联系人字段、标签及其最近发布的 20 个营销活动,因此有效属性无法硬编码。在创建或更新分段之前,请先阅读它以发现有效的 attribute、operator 和 value 组合。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/segmentation/filters/attributes
reach_segments_preview-contacts-matching-conditions
预览匹配一组条件的联系人,而无需保存分段。
请求体与创建或更新分段时接受的条件集相同,因此这是在持久化之前检查筛选器覆盖谁以及覆盖多少人的方法。不会存储任何内容,也不会修改任何联系人。
请先调用分段筛选属性端点以发现有效的 attribute、operator 和 value 组合。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/segmentation/filters/contacts
reach_segments_list-profile
获取配置文件中定义的分段的分页列表。
每个条目都带有当前匹配它的联系人数量,该数量在读取时重新计算而非存储。使用 count_type 可统计所有匹配联系人或仅统计已订阅的联系人。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments
reach_segments_create-profile
在配置文件中创建分段。
分段是保存的条件集而非固定列表,因此其成员会随着联系人的变化而变化。创建分段不会修改任何联系人。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments
reach_segments_list-contacts
检索与特定分段关联的联系人。
此端点允许您获取和筛选属于特定分段(由其 UUID 标识)的联系人。
已弃用。 此端点无法指定配置文件,因此始终回退到客户端的默认配置文件,无法读取任何其他配置文件的分段。请改用 GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts。
- 方法:
GET - 路径:
/api/reach/v1/segmentation/segments/{segmentUuid}/contacts
reach_segments_get
获取特定分段的详细信息。
此端点检索由 UUID 标识的单个分段的信息。分段用于根据特定条件组织和分组联系人。
已弃用。 此端点无法针对特定配置文件,因此始终回退到客户端的默认配置文件,并且无法读取任何其他配置文件的细分。请改用 GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}。
- 方法:
GET - 路径:
/api/reach/v1/segmentation/segments/{segmentUuid}
reach_tags_assign-contact-to
为单个联系人分配标签。
与批量端点不同,此操作会立即执行,而不是排队执行。为联系人已拥有的标签分配标签会成功,且不会重复添加。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}
reach_tags_remove-contact-from
从单个联系人移除标签。
与批量端点不同,此操作会立即执行,而不是排队执行。标签和联系人都不会被删除。
- 方法:
DELETE - 路径:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}
reach_tags_assign-contacts-to
一次为多个联系人分配标签。
传入 contact_uuids 以定位特定联系人,或传入 all_contacts 以定位配置文件中的每个联系人。该操作会排队执行,因此成功响应仅表示请求已被接受,而非已完成。已拥有该标签的联系人将保持不变。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts
reach_tags_remove-contacts-from
一次从多个联系人移除标签。
传入 contact_uuids 以定位特定联系人,或传入 all_contacts 以定位配置文件中的每个联系人。该操作会排队执行,因此成功响应仅表示请求已被接受,而非已完成。标签本身和联系人都不会被删除。
- 方法:
DELETE - 路径:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts
reach_tags_delete
删除标签,并将其从所有拥有该标签的联系人处移除。
联系人本身不会被删除。此操作是幂等的:删除配置文件中不存在的标签仍然会成功。
- 方法:
DELETE - 路径:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}
reach_tags_rename
重命名标签。
分配给该标签的联系人不受影响。名称在配置文件内是唯一的,因此将标签重命名为已存在的名称会被拒绝。
- 方法:
PATCH - 路径:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}
reach_tags_list-profile
获取配置文件中定义的所有标签。
标签是 Reach 中对联系人进行分组的方式,可用于筛选联系人列表或构建细分。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/tags
reach_tags_create-or-find
在配置文件中创建标签。
配置文件中已存在的名称不会被重复创建:而是返回现有标签,因此该调用可以安全地重复执行。请求中的每个标签都会被返回,无论它是刚刚创建的还是已经存在的。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/tags
reach_forms_get
获取单个表单,包括其托管模板的 URL 以及它应用于所捕获联系人的标签。
响应中没有现成的嵌入代码片段——您可以自行提供模板 HTML,或围绕表单 UUID 构建自己的嵌入。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}
reach_forms_delete
永久删除表单及其模板。
已捕获提交内容的表单无法删除,以免其收集的联系人被静默丢弃——请暂停表单以停止收集新提交。仅视图不会阻止删除。
- 方法:
DELETE - 路径:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}
reach_forms_list
获取配置文件中注册表单的分页列表。
每个表单都带有渲染它的模板的引用。获取表单详情以获取可直接使用的模板 URL,以及表单应用于所捕获联系人的标签。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/forms
reach_profiles_connected-sending-domain
获取连接到配置文件的发送域名、其验证状态以及任何被暂停的发件人地址。
只有在域名已连接并激活后,营销活动才会发出,因此这是在构建营销活动之前检查该前提条件的最简单方法。未连接域名的配置文件会返回相同结构,所有字段均设置为 null。如需了解状态背后的 MX、SPF、DKIM 和 DMARC 单独记录,请使用 DNS 状态端点。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/domains
reach_profiles_connect-sending-domain
将发送域名连接到配置文件,以便可以从该域名上的地址发送电子邮件。
连接并不会使域名立即可用于发送:请接下来检查 DNS 状态端点,查看仍缺失的记录。账户拥有或已验证的域名会立即连接。任何其他域名会启动 TXT 所有权验证并返回 409;请在 Reach 中完成验证,然后重试。当配置文件或其他配置文件已拥有该域名、域名被阻止或无法验证其所有权时,返回 422。已连接的域名永远不会被替换。
成功后,草稿和已排期营销活动的发件人地址,以及已发布的自动化和双重选择加入电子邮件的发件人地址,会在后台迁移到新域名,保留 @ 之前的部分。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/domains
reach_profiles_delete-sending-domain
断开配置文件与发送域名的连接。
域名记录会被移除,因此配置文件之后将没有发送域名,在重新连接域名之前无法发送营销活动。已存储在营销活动、自动化和设置中的发件人地址保持不变,并继续指向已移除的域名。未连接到配置文件的域名也会成功,因此成功并不证明有任何内容被删除。DNS 提供商处的 DNS 记录不会被移除。要切换域名,请删除当前域名并连接新域名。调用前请与客户确认域名。
- 方法:
DELETE - 路径:
/api/reach/v1/profiles/{profileUuid}/domains
reach_profiles_domain-dns-status
检索配置文件域名的 DNS 配置状态。
此端点报告 MX、SPF、DKIM 和 DMARC 记录的状态,包括实际找到的记录以及正确投递电子邮件所需的建议记录。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/domains/dns-status
reach_profiles_list-plan-feature-access
列出配置文件可以使用的套餐功能。
这是功能锁定矩阵,而非使用配额。available 表示该功能当前可以使用,locked 表示它不属于基础套餐,因此需要升级。如需了解剩余电子邮件、收件人和 AI 积分,请改用限额端点。
在构建之后无法激活的内容(例如在未启用自动化激活的套餐上构建自动化)之前,值得先检查此项。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/features
reach_profiles_remaining-plan-limits
获取当前周期内套餐的剩余用量。
在基于此构建警报之前,有两点需要牢记。周期是自然月而非账单周年日,因此无论订阅何时开始,计数器都会在每月 1 日重置。此外,使用量按订单跟踪,因此同一订单上的每个配置文件共享一个池,并在此处报告相同的数字。仅提供当前周期,不保留过去的使用量。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/limits
reach_profiles_list
此端点返回客户端可用的所有配置文件,包括其基本信息。
- 方法:
GET - 路径:
/api/reach/v1/profiles
reach_profiles_settings
获取配置文件保存的发件人身份和品牌详情。
在创建营销活动之前读取默认发件人,而不是询问客户,并在生成电子邮件内容时复用品牌字段。对于从未填写过设置的配置文件,任何字段都可以是 null。此操作不检查发送域名是否已验证,请使用已连接发送域名端点进行该检查。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/settings
reach_profiles_update-settings
更改配置文件的默认发件人和品牌详情。
仅发送要更改的字段:每个省略的字段都会保留其值,null 或空字符串会清除文本字段。默认发件人是之后创建的营销活动的起始发件人;现有营销活动保留自己的发件人。sender_email 只是 @ 之前的部分,因为 Reach 会将其与配置文件已连接的发送域名组合,因此无法设置该域名之外的地址。连接发送域名是单独的端点,此处无法更改已连接的域名。返回更改后的设置。
- 方法:
PATCH - 路径:
/api/reach/v1/profiles/{profileUuid}/settings
reach_templates_list-email
获取配置文件中的电子邮件模板列表,最近更新的优先。
模板是构建营销活动所依据的可复用电子邮件正文。列表不分页,仅返回元数据——模板内容本身不会暴露。使用模板的 uuid 作为创建营销活动时的 template_uuid。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/templates
reach_templates_create-email
在配置文件中创建电子邮件模板。
模板保存营销活动复用的 HTML 正文,因此可以在任何营销活动存在之前创建。仅返回模板元数据——请保留返回的 uuid,以将其作为营销活动的 template_uuid 引用。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/templates
hostinger-vps-mcp
vps_data-centers_list
检索所有可用的数据中心。
在部署 VPS 实例之前,使用此端点查看位置选项。
- 方法:
GET - 路径:
/api/vps/v1/data-centers
vps_docker_containers
检索虚拟机上特定 Docker Compose 项目的所有容器列表。
此端点返回每个容器的详细信息,包括其当前状态、端口映射和运行时配置。
使用此端点监控 Docker Compose 项目中所有服务的健康状况和状态。
- 方法:
GET - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/containers
vps_docker_get
检索完整的项目信息,包括 docker-compose.yml 文件内容、项目元数据和当前部署状态。
此端点提供特定 Docker Compose 项目的完整配置和状态详情。
使用此端点检查项目设置、查看 compose 文件或检查项目的整体健康状况。
- 方法:
GET - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}
vps_docker_delete
从虚拟机完全移除 Docker Compose 项目,停止所有容器并清理相关资源,包括网络、卷和镜像。
此操作不可逆,将删除所有项目数据。
当您希望永久移除项目并释放系统资源时,请使用此端点。
- 方法:
DELETE - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/down
vps_docker_list
检索当前部署在虚拟机上的所有 Docker Compose 项目列表。
此端点返回每个项目的基本信息,包括名称、状态、文件路径以及容器列表,其中包含名称、镜像、状态、健康状况和端口等详情。此端点不包含容器统计信息。如果您需要获取包含统计信息的容器详细信息,请使用 Get project containers 端点。
使用此端点获取 VPS 实例上所有 Docker 项目的概览。
- 方法:
GET - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker
vps_docker_create
从 docker-compose.yaml 内容部署新项目,或从 URL 下载内容。 URL 可以是 GitHub 仓库地址,格式为 https://github.com/[user]/[repo], 它将自动解析为 master 分支中的 docker-compose.yaml 文件。 任何其他提供的 URL 必须返回 docker-compose.yaml 文件内容。
如果同名项目已存在,现有项目将被替换。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker
vps_docker_logs
检索 Docker Compose 项目中所有服务的聚合日志条目。
此端点返回每个容器的最近日志输出,按服务名称组织并带有时间戳。 响应包含所有服务中最近 300 条日志条目。
用于调试、监控应用程序行为以及排查整个项目栈中的问题。
- 方法:
GET - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/logs
vps_docker_restart
通过按正确的依赖顺序停止和启动容器,重启 Docker Compose 项目中的所有服务。
此操作保留数据卷和网络配置,同时刷新正在运行的容器。
用于应用配置更改或从服务故障中恢复。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/restart
vps_docker_start
启动 Docker Compose 项目中当前已停止的所有服务。
此操作按 compose 文件中定义的正确依赖顺序启动容器。
用于恢复之前已停止的项目,或在系统重启后启动服务。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/start
vps_docker_stop
停止 Docker Compose 项目中所有正在运行的服务,同时保留容器配置和数据卷。
此操作按逆依赖顺序优雅地关闭容器。
用于在不删除数据或配置的情况下临时暂停项目。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/stop
vps_docker_update
通过拉取最新镜像版本并使用新配置重新创建容器,更新 Docker Compose 项目。
此操作在应用 compose 文件中的更改时保留数据卷。
用于部署应用程序更新、应用配置更改或将容器镜像刷新到最新版本。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/update
vps_firewall_activate
为指定的虚拟机激活防火墙。
一台虚拟机一次只能激活一个防火墙。
使用此端点将防火墙规则应用到 VPS 实例。
- 方法:
POST - 路径:
/api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}
vps_firewall_deactivate
为指定的虚拟机停用防火墙。
使用此端点从 VPS 实例中移除防火墙保护。
- 方法:
POST - 路径:
/api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}
vps_firewall_get
按 ID 检索防火墙及其关联的规则。
使用此端点查看特定的防火墙配置和规则。
- 方法:
GET - 路径:
/api/vps/v1/firewall/{firewallId}
vps_firewall_delete
删除指定的防火墙。
任何激活了此防火墙的虚拟机将自动停用该防火墙。
使用此端点移除未使用的防火墙配置。
- 方法:
DELETE - 路径:
/api/vps/v1/firewall/{firewallId}
vps_firewall_list
检索所有可用的防火墙。
使用此端点查看现有的防火墙配置。
- 方法:
GET - 路径:
/api/vps/v1/firewall
vps_firewall_create
创建新的防火墙。
使用此端点设置新的防火墙配置以保障 VPS 安全。
- 方法:
POST - 路径:
/api/vps/v1/firewall
vps_firewall_update-rule
更新指定防火墙中的特定防火墙规则。
任何激活了此防火墙的虚拟机将失去与防火墙的同步, 需要手动重新同步。
使用此端点修改现有的防火墙规则。
- 方法:
PUT - 路径:
/api/vps/v1/firewall/{firewallId}/rules/{ruleId}
vps_firewall_delete-rule
删除指定防火墙中的特定防火墙规则。
任何激活了此防火墙的虚拟机将失去与防火墙的同步, 需要手动重新同步。
使用此端点移除特定的防火墙规则。
- 方法:
DELETE - 路径:
/api/vps/v1/firewall/{firewallId}/rules/{ruleId}
vps_firewall_replace-all-rules-in-group
在单个原子操作中,用提供的规则集替换指定防火墙组中的所有防火墙规则, 而不是逐个创建或删除规则。
任何使用此防火墙组的虚拟机在替换规则后都需要同步; 传递 "sync" 参数可立即触发同步。
- 方法:
PUT - 路径:
/api/vps/v1/firewall/{firewallId}/rules
vps_firewall_create-rule
为指定的防火墙创建新的防火墙规则。
默认情况下,防火墙会丢弃所有传入流量, 这意味着您必须为您想要使用的所有端口添加接受规则。
任何激活了此防火墙的虚拟机将失去与防火墙的同步, 需要手动重新同步。
使用此端点向防火墙添加新的安全规则。
- 方法:
POST - 路径:
/api/vps/v1/firewall/{firewallId}/rules
vps_firewall_sync-to-all-assigned-v-ms
将防火墙的规则同步到其分配到的每台虚拟机。
如果防火墙添加、移除或更新了新规则,防火墙可能会与虚拟机失去同步。
使用此端点将更新后的防火墙规则应用到分配给该防火墙的所有 VPS 实例。
- 方法:
POST - 路径:
/api/vps/v1/firewall/{firewallId}/sync
vps_firewall_sync
已弃用:请改用 POST /api/vps/v1/firewall/{firewallId}/sync,它会将防火墙同步到
所有分配了该防火墙的虚拟机。
为指定的虚拟机同步防火墙。
如果防火墙添加、移除或更新了新规则,防火墙可能会与虚拟机失去同步。
使用此端点将更新后的防火墙规则应用到 VPS 实例。
- 方法:
POST - 路径:
/api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}
vps_post-install-scripts_get
按 ID 检索后安装脚本。
使用此端点查看特定的自动化脚本详情。
- 方法:
GET - 路径:
/api/vps/v1/post-install-scripts/{postInstallScriptId}
vps_post-install-scripts_update
更新特定的后安装脚本。
使用此端点修改现有的自动化脚本。
- 方法:
PUT - 路径:
/api/vps/v1/post-install-scripts/{postInstallScriptId}
vps_post-install-scripts_delete
从您的账户中删除后安装脚本。
使用此端点移除未使用的自动化脚本。
- 方法:
DELETE - 路径:
/api/vps/v1/post-install-scripts/{postInstallScriptId}
vps_post-install-scripts_list
检索与您的账户关联的后安装脚本。
使用此端点查看可用于 VPS 部署的自动化脚本。
- 方法:
GET - 路径:
/api/vps/v1/post-install-scripts
vps_post-install-scripts_create
向您的账户添加新的后安装脚本,该脚本可在虚拟机安装后使用。
脚本内容将保存到文件 /post_install,并设置可执行属性,
在虚拟机安装完成后执行。
脚本的输出将重定向到 /post_install.log。脚本最大大小为 48KB。
使用此端点创建用于 VPS 设置任务的自动化脚本。
- 方法:
POST - 路径:
/api/vps/v1/post-install-scripts
vps_public-keys_attach
已弃用:请改用 POST /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys。
将您账户中现有的公钥附加到指定的虚拟机。
可以将多个密钥附加到单个虚拟机。
使用此端点启用 VPS 实例的 SSH 密钥认证。
- 方法:
POST - 路径:
/api/vps/v1/public-keys/attach/{virtualMachineId}
vps_public-keys_delete
已弃用:账户级公钥没有直接替代品。根 SSH 密钥现在通过
DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys 按虚拟机进行管理。
从您的账户中删除公钥。
从账户中删除公钥不会将其从虚拟机中移除
使用此端点从账户中移除未使用的 SSH 密钥。
- 方法:
DELETE - 路径:
/api/vps/v1/public-keys/{publicKeyId}
vps_public-keys_list
已弃用:账户级公钥没有直接替代品。根 SSH 密钥现在通过
GET /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys 按虚拟机进行管理。
检索与您的账户关联的公钥。
使用此端点查看可用于 VPS 认证的 SSH 密钥。
- 方法:
GET - 路径:
/api/vps/v1/public-keys
vps_public-keys_create
已弃用:账户级公钥没有直接替代品。根 SSH 密钥现在通过
POST /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys 按虚拟机进行管理。
向您的账户添加新的公钥。
使用此端点注册用于 VPS 认证的 SSH 密钥。
- 方法:
POST - 路径:
/api/vps/v1/public-keys
vps_ssh-keys_list-virtual-machine
检索指定虚拟机上当前配置的 SSH 公钥。
仅列出 root 用户的密钥。
使用此端点查看可用于 VPS 实例认证的 SSH 密钥。
- 方法:
GET - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys
vps_ssh-keys_add-virtual-machine
向指定的虚拟机添加一个或多个 SSH 公钥。
密钥将添加到 root 用户,可用于免密码 SSH 认证。
返回虚拟机上当前配置的完整 SSH 密钥列表。
使用此端点启用 VPS 实例的 SSH 密钥认证。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys
vps_ssh-keys_remove-virtual-machine
从指定的虚拟机中移除一个或多个 SSH 公钥。
移除的密钥将无法再以 root 用户身份通过 SSH 进行认证。
返回虚拟机上配置的剩余 SSH 密钥列表。
使用此端点撤销对 VPS 实例的 SSH 密钥访问权限。
- 方法:
DELETE - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys
vps_templates_get
检索有关特定虚拟机操作系统模板的详细信息。
使用此端点在部署前查看特定的模板规格。
- 方法:
GET - 路径:
/api/vps/v1/templates/{templateId}
vps_templates_list
检索可用的虚拟机操作系统模板。
使用此端点在创建或重新创建 VPS 实例前查看操作系统选项。
- 方法:
GET - 路径:
/api/vps/v1/templates
vps_actions_get
检索有关指定虚拟机上执行的特定操作的详细信息。
使用此端点监控特定 VPS 操作的状态和详情。
- 方法:
GET - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}
vps_actions_list
检索在指定虚拟机上执行的操作。
操作是在虚拟机上执行的操作或事件, 例如启动、停止或修改机器。此端点 允许您查看这些操作的历史记录,提供每个 操作的详细信息,如操作名称、时间戳和状态。
使用此端点查看 VPS 操作历史并排查问题。
- 方法:
GET - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/actions
vps_virtual-machines_attached-public-keys
已弃用:请改用 GET /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys。
检索附加到指定虚拟机的公钥。
使用此端点查看为特定 VPS 实例配置的 SSH 密钥。
- 方法:
GET - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/public-keys
vps_backups_list
检索指定虚拟机的备份。
使用此端点查看可用于 VPS 数据恢复的备份点。
- 方法:
GET - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/backups
vps_backups_restore
为指定的虚拟机恢复备份。 系统随后将启动恢复流程,所需时间取决于备份的大小。
虚拟机上的所有数据将被备份中的数据覆盖。
使用此端点可从备份点恢复VPS数据。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore
vps_virtual-machines_set-hostname
为指定的虚拟机设置主机名。
更改主机名不会自动更新PTR记录。 如果您希望通过主机名访问虚拟机, 还需要将域名的A/AAAA记录指向虚拟机IP。
使用此端点可为VPS实例配置自定义主机名。
- 方法:
PUT - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/hostname
vps_virtual-machines_reset-hostname
将指定虚拟机的主机名和PTR记录重置为默认值。
使用此端点可恢复VPS实例的默认主机名配置。
- 方法:
DELETE - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/hostname
vps_virtual-machines_get
检索指定虚拟机的详细信息。
使用此端点可查看完整的VPS配置和状态。
- 方法:
GET - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}
vps_virtual-machines_list
检索所有可用的虚拟机。
使用此端点可查看可用的VPS实例。
- 方法:
GET - 路径:
/api/vps/v1/virtual-machines
vps_virtual-machines_purchase
购买并设置新的虚拟机。
如果虚拟机设置因任何原因失败,请登录 hPanel并手动完成设置。
如果未提供付款方式,将自动使用您的默认付款方式。
如果响应为202 Accepted,则表示付款仍在处理中,虚拟机
尚未设置。请登录
hPanel并手动完成设置。
使用此端点可创建新的VPS实例。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines
vps_monarx_scan-metrics
检索安装在指定虚拟机上的Monarx恶意软件扫描器的扫描指标。
扫描指标提供有关Monarx执行的恶意软件扫描的详细信息, 包括扫描次数、检测到的威胁以及其他相关统计信息。 这些信息有助于监控虚拟机的安全状态并评估恶意软件扫描器的有效性。
使用此端点可监控VPS安全扫描结果和威胁检测。
- 方法:
GET - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/monarx
vps_monarx_install
在指定的虚拟机上安装Monarx恶意软件扫描器。
Monarx是一款安全工具,旨在检测和 防止虚拟机上的恶意软件感染。通过安装Monarx,用户 可以增强虚拟机的安全性,确保其免受恶意软件的侵害。
使用此端点可在VPS实例上启用恶意软件保护。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/monarx
vps_monarx_uninstall
卸载指定虚拟机上的Monarx恶意软件扫描器。
如果未安装Monarx,请求仍会被处理,但不会产生任何效果。
使用此端点可从VPS实例中移除恶意软件扫描器。
- 方法:
DELETE - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/monarx
vps_virtual-machines_metrics
检索指定虚拟机的历史指标。
包括以下指标:
- CPU使用率
- 内存使用率
- 磁盘使用率
- 网络使用率
- 运行时间
使用此端点可监控VPS性能和资源利用率随时间的变化。
- 方法:
GET - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/metrics
vps_virtual-machines_set-nameservers
为指定的虚拟机设置域名服务器。
请注意,不正确的域名服务器配置可能导致虚拟机 无法解析域名。
使用此端点可为VPS实例配置自定义DNS解析器。
- 方法:
PUT - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/nameservers
vps_ptr_create
为指定的虚拟机创建或更新PTR(指针)记录。
使用此端点可为VPS IP地址配置反向DNS查询。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}
vps_ptr_delete
删除指定虚拟机的PTR(指针)记录。
删除后,对虚拟机IP地址的反向DNS查询将 不再返回之前配置的主机名。
使用此端点可从VPS实例中移除反向DNS配置。
- 方法:
DELETE - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}
vps_virtual-machines_set-panel-password
为指定的虚拟机设置面板密码。
如果虚拟机不使用面板操作系统,请求仍会被处理,但不会产生任何效果。 密码要求与重新创建虚拟机 端点相同。
使用此端点可为VPS实例配置控制面板访问凭据。
- 方法:
PUT - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/panel-password
vps_recovery_start
为指定的虚拟机启动恢复模式。
恢复模式是一种特殊状态,允许用户执行系统救援操作, 例如修复文件系统、恢复数据或排查阻止虚拟机正常启动的问题。
虚拟机将启动恢复磁盘映像,原始磁盘映像将挂载在/mnt目录中。
使用此端点可在VPS实例上启用系统救援操作。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/recovery
vps_recovery_stop
停止指定虚拟机的恢复模式。
如果虚拟机不处于恢复模式,此操作将失败。
使用此端点可退出系统救援模式并使VPS恢复正常运行。
- 方法:
DELETE - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/recovery
vps_virtual-machines_recreate
从头重新创建虚拟机。
重新创建过程包括重新安装操作系统并将 虚拟机重置为初始状态。如果有快照,将被删除。
密码要求
密码将对照泄露密码数据库进行检查。 密码要求如下:
- 至少12个字符长
- 至少一个大写字母
- 至少一个小写字母
- 至少一个数字
- 未公开泄露
此操作不可逆,将导致虚拟机中存储的所有数据丢失!
使用此端点可通过全新操作系统安装完全重建VPS实例。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/recreate
vps_virtual-machines_restart
通过完全停止并启动来重启指定的虚拟机。
如果虚拟机已停止,它将被启动。
使用此端点可重启VPS实例。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/restart
vps_virtual-machines_set-root-password
为指定的虚拟机设置root密码。
密码要求与重新创建虚拟机 端点相同。
使用此端点可更新VPS实例的管理员凭据。
- 方法:
PUT - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/root-password
vps_virtual-machines_setup
使用initial状态设置新购买的虚拟机。
使用此端点可配置和初始化已购买的VPS实例。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/setup
vps_snapshots_get
检索指定虚拟机的快照。
使用此端点可查看当前VPS快照信息。
- 方法:
GET - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
vps_snapshots_create
为指定的虚拟机创建快照。
快照在特定时间点捕获虚拟机的状态和数据, 允许用户在需要时将虚拟机恢复到该状态。 此操作适用于备份目的、系统恢复以及在不影响虚拟机当前状态的情况下测试更改。
创建新快照将覆盖现有快照!
使用此端点可捕获VPS状态以用于备份和恢复目的。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
vps_snapshots_delete
删除指定虚拟机的快照。
使用此端点可移除VPS快照。
- 方法:
DELETE - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
vps_snapshots_restore
使用快照将指定的虚拟机恢复到之前的状态。
从快照恢复允许用户将虚拟机还原到该状态, 适用于系统恢复、撤销更改或测试。
使用此端点可将VPS实例恢复到之前保存的状态。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot/restore
vps_virtual-machines_start
启动指定的虚拟机。
如果虚拟机已在运行,请求仍会被处理,但不会产生任何效果。
使用此端点可启动已停止的VPS实例。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/start
vps_virtual-machines_stop
停止指定的虚拟机。
如果虚拟机已停止,请求仍会被处理,但不会产生任何效果。
这只是计算资源的电源状态更改,不影响计费。要停止未来的费用, 请禁用所属订阅的自动续费。
使用此端点可关闭正在运行的VPS实例。
- 方法:
POST - 路径:
/api/vps/v1/virtual-machines/{virtualMachineId}/stop
hostinger-wordpress-mcp
wordpress_ai-content_generate-images
根据提示和图像类型为指定的WordPress安装开始生成一张或多张图像。
生成过程异步运行:响应会立即返回,包含status: in-progress和generation_id。每隔几秒轮询
GET /api/hosting/v1/accounts/{username}/wordpress/{software}/content/generations/{generation_id}
直到status为completed或failed。
完成的生成会返回临时图像URL及其过期时间; 请在此之前下载图像。图像符合请求的宽高比,且不会 小于请求的尺寸;徽标是裁剪到标记的透明图像。
每个安装同时只能运行一个图像生成任务:当仍有任务在进行时,
端点返回409且不包含正在运行生成的ID,因此未收到202的调用方
必须等待其完成(最多几分钟)后才能开始新的任务。该端点限制为每分钟10个请求。
在路径中提供WordPress安装(软件)标识符。可通过
GET /api/hosting/v1/wordpress/installations获取(id字段)。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/content/images/generate
wordpress_ai-content_generation-result
获取为指定WordPress安装启动的AI内容生成结果, 例如通过POST /api/hosting/v1/accounts/{username}/wordpress/{software}/content/images/generate启动的图像生成。
当生成仍在运行时,仅返回status: in-progress;请每隔几秒轮询。
一旦completed,result将包含根据type生成的形状的内容:对于image-generation,为临时图像URL及其过期时间;对于website-generation(从Hostinger
WordPress插件启动),为生成的网站文档。failed生成没有result。未知或过期的生成
ID返回404。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/content/generations/{generation_id}
wordpress_ai-tools_show-option-status
显示指定 WordPress 安装上 Hostinger Tools 插件的当前 AI 选项状态。按 option 筛选以返回单个选项,或省略以返回所有选项。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/hostinger-plugins/ai-option/status
wordpress_ai-tools_set-option-status
启用或禁用指定 WordPress 安装上 Hostinger Tools 插件的 AI 选项。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/hostinger-plugins/ai-option/status
wordpress_installations_check-if-are-valid
检查一个或多个 WordPress 安装是否有效且运行正常。检测因缺少文件、插件或主题损坏等类似问题导致的安装故障。
在请求体中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/installations/check-is-valid
wordpress_installations_delete
删除指定的 WordPress 安装,可选择同时删除文件和数据库。这将移除所有关联组件,包括插件、主题、暂存网站及其他相关数据。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
DELETE - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}
wordpress_installations_detect
触发后台扫描以检测账户的 WordPress 安装。
此操作是异步的:成功响应仅表示扫描已排队。轮询 GET /api/hosting/v1/wordpress/installations 以在扫描完成后获取检测到的安装。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/installations/detect
wordpress_installations_import-website
将 WordPress 网站导入到指定域名。
警告:此操作会覆盖网站现有内容且无法撤销——在调用此端点前请确认这是预期操作。
此端点允许您从已上传到网站目录的归档文件和数据库文件导入 WordPress 网站。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/wordpress/import
wordpress_installations_install
在现有网站上安装 WordPress。
调用此端点前网站必须已存在。要首先创建新网站,请使用 POST /api/hosting/v1/websites 并轮询 GET /api/hosting/v1/websites 直到其出现。
在继续之前,调用按用户名和域名筛选的 GET /api/hosting/v1/wordpress/installations 以检查 WordPress 是否已安装在目标域名/路径上。如果 WordPress 已存在且 overwrite 为 false(默认值),异步任务将失败。
此操作是异步的:成功响应仅表示安装任务已排队,而非 WordPress 已就绪。安装通常需要 1-2 分钟。轮询按用户名和域名筛选的 GET /api/hosting/v1/wordpress/installations 以跟踪进度。当安装出现在该列表中时,WordPress 即已就绪。
当账户已使用其套餐允许的所有数据库时返回 422,除非 database.name 是账户上的现有数据库。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/installations
wordpress_installations_list
列出经过身份验证的客户端可访问的共享和云虚拟主机账户(/api/hosting/v1 系列,由 username 标识)上的 WordPress 安装。
Agency Plan 网站不包含在内。要处理 Agency Plan 网站上的 WordPress,请使用 GET /api/agency-hosting/v1/websites?website_types=wordpress 列出它们,并通过 GET /api/agency-hosting/v1/websites/{website_uid}/wordpress/settings 读取其详细信息。仅拥有 Agency Plan 网站的账户从此端点接收空列表。
使用此端点发现现有 WordPress 安装,并在调用安装端点后轮询安装状态。当新请求的安装出现在此列表中时,WordPress 即已就绪。按用户名和域名筛选以将结果缩小到特定网站。
每个安装包含一个 valid 标志,当无效时,还包含一个描述原因的 validationError。
- 方法:
GET - 路径:
/api/hosting/v1/wordpress/installations
wordpress_installations_list-core-updates
列出指定安装可用的 WordPress 核心更新。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/updates
wordpress_installations_jwt-token
返回用于对指定 WordPress 安装(包括其 MCP(模型上下文协议)端点)进行请求身份验证的 JWT 令牌。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/jwt-token
wordpress_installations_show-core-version
显示指定安装的 WordPress 核心版本,以及影响它的已知漏洞。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/version
wordpress_installations_update-core
更新指定安装的 WordPress 核心(次要更新或特定版本)。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
此操作是异步的:成功响应仅表示更新任务已排队。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/update
wordpress_litespeed-cache_purge-lite-speed
清除指定 WordPress 安装的 LiteSpeed Cache。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/litespeed-cache/purge
wordpress_litespeed-cache_show-lite-speed-status
显示指定 WordPress 安装的 LiteSpeed Cache 状态。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/litespeed-cache/status
wordpress_login_create-links
为指定 WordPress 安装创建临时自动登录链接。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/login/links
wordpress_maintenance_show-status
显示指定 WordPress 安装的维护模式状态。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/maintenance/status
wordpress_maintenance_toggle
根据 enabled 标志启用或禁用指定 WordPress 安装的维护模式。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/maintenance/toggle
wordpress_object-cache_show-memcached-status
显示指定 WordPress 安装的 Memcached 对象缓存状态。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/memcached/status
wordpress_object-cache_toggle-memcached
根据 enabled 标志激活或停用指定 WordPress 安装的 Memcached 对象缓存。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/memcached/toggle
wordpress_plugins_activate
激活 WordPress 安装上已安装的插件。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
此操作是异步的:成功响应仅表示激活任务已排队。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/activate
wordpress_plugins_deactivate
停用 WordPress 安装上已安装的插件。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
此操作是异步的:成功响应仅表示停用任务已排队。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/deactivate
wordpress_plugins_deploy
从已上传的目录部署 WordPress 插件。
此端点允许您部署已上传到网站目录的 WordPress 插件。该插件将被激活并在 WordPress 管理面板中可用。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/wordpress/plugins/deploy
wordpress_plugins_install
在现有 WordPress 安装上安装一个或多个插件。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。使用 GET /api/hosting/v1/wordpress/plugins 发现可用于安装的插件 slug。
此操作是异步的:成功响应仅表示安装任务已排队,而非插件已就绪。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install
wordpress_plugins_list
列出推荐在 WordPress 安装上安装但尚未安装的插件。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/available
wordpress_plugins_list-installed
列出 WordPress 安装上已安装的插件,包括其状态、可用更新和已知漏洞。
在路径中提供 WordPress 安装(软件)标识符。可以通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins
wordpress_plugins_search
在 WordPress.org 插件目录中搜索可安装的插件。
将返回的 slug 值与 POST /api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install 一起使用。
- 方法:
GET - 路径:
/api/hosting/v1/wordpress/plugins
wordpress_plugins_list-suggested
列出按网站类型分组的精选插件建议。
使用返回的 slug 值配合
POST /api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install。
- 方法:
GET - 路径:
/api/hosting/v1/wordpress/plugins/suggested
wordpress_plugins_check-if-woo-commerce-is-installed
检查某个域名的任何 WordPress 安装中是否已安装 WooCommerce。可选地按域名过滤以限定检查范围。
- 方法:
GET - 路径:
/api/hosting/v1/wordpress/plugins/is-woocommerce-installed
wordpress_plugins_uninstall
从 WordPress 安装中卸载一个或多个插件。
在路径中提供 WordPress 安装(软件)标识符。可通过
GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
此操作是异步的:成功响应仅表示卸载任务已排队。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/uninstall
wordpress_plugins_update-hostinger
将 WordPress 安装上的 Hostinger 插件更新到最新版本。
在路径中提供 WordPress 安装(软件)标识符。可通过
GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
此操作是异步的:成功响应仅表示更新任务已排队。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/hostinger/update
wordpress_plugins_update
将 WordPress 安装上的一个或多个已安装插件更新到最新版本。
在路径中提供 WordPress 安装(软件)标识符。可通过
GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
此操作是异步的:成功响应仅表示更新任务已排队。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/update
wordpress_themes_activate
在 WordPress 安装上激活已安装的主题。
在路径中提供 WordPress 安装(软件)标识符。可通过
GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
此操作是异步的:成功响应仅表示激活任务已排队。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes/activate
wordpress_themes_deploy
从已上传的目录部署 WordPress 主题。
此端点允许您部署已上传到网站目录的 WordPress 主题。 部署后可以选择激活该主题。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/wordpress/themes/deploy
wordpress_themes_install
在现有的 WordPress 安装上安装主题。
在路径中提供 WordPress 安装(软件)标识符。可通过
GET /api/hosting/v1/wordpress/installations 获取(id
字段)。
当主题是 Hostinger 主题之一(hostinger-blog、
hostinger-affiliate-theme、hostinger-ai-theme)时,可选的 palette、
layout 和 font 字段会转发给自定义安装程序(默认值:
palette1、layout1、default)。对于任何其他主题,这些字段将被忽略。
此操作是异步的:成功响应仅表示安装任务已排队,并不表示主题已就绪。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes/install
wordpress_themes_list-installed
列出 WordPress 安装上已安装的主题,包括其状态、 可用更新和已知漏洞。
在路径中提供 WordPress 安装(软件)标识符。可通过
GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes
wordpress_themes_list
列出可安装的 WordPress 主题。
使用返回的 slug 值配合
POST /api/hosting/v1/accounts/{username}/wordpress/{software}/themes/install。
- 方法:
GET - 路径:
/api/hosting/v1/wordpress/themes
wordpress_themes_uninstall
从 WordPress 安装中卸载一个或多个主题。
在路径中提供 WordPress 安装(软件)标识符。可通过
GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
此操作是异步的:成功响应仅表示卸载任务已排队。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes/uninstall
wordpress_themes_update
将 WordPress 安装上的一个或多个已安装主题更新到最新版本。
在路径中提供 WordPress 安装(软件)标识符。可通过
GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
此操作是异步的:成功响应仅表示更新任务已排队。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes/update