关于 Hostinger
Hostinger API 的 MCP 服务,通过统一或按产品领域划分的操作集,让 MCP 客户端执行托管、域名、账单等 API 操作。支持托管远程连接及本地运行,并提供 OAuth 或 API 令牌认证。
主要功能
- 01覆盖 Hostinger API 多个领域
- 02按领域拆分服务命令
- 03搜索并执行 API 操作
- 04按顺序批量执行操作
- 05支持 OAuth 与 API 令牌
- 06提供远程及本地传输方式
适用场景
- 01查询并管理托管服务
- 02执行域名与 DNS 操作
- 03处理账单和 VPS 操作
MCP 相关
向 MCP 客户端提供 `search`、`execute` 和 `multi-execute` 工具,用于发现和调用 Hostinger API 操作。可连接托管远程服务,也可通过 stdio 或 Streamable HTTP 本地运行。
配置
远程服务无需本地安装。选择你使用的客户端,复制配置或使用一键安装。
https://mcp.hostinger.comclaude mcp add --transport http hostinger https://mcp.hostinger.com{"mcpServers":{"hostinger":{"type":"http","url":"https://mcp.hostinger.com"}}}在 Cursor 中打开{"servers":{"hostinger":{"type":"http","url":"https://mcp.hostinger.com"}}}在 VS Code 中打开{"mcpServers":{"hostinger":{"type":"http","url":"https://mcp.hostinger.com"}}}{"mcpServers":{"hostinger":{"serverUrl":"https://mcp.hostinger.com"}}}命令在终端中运行;JSON 粘贴到对应客户端的 MCP 配置后重启。需要授权的服务会在首次连接时提示登录。
工具
3| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| operation | string | 是 | 搜索返回的操作名称。 |
| params | object | 否 | 符合操作 inputSchema 的参数。 |
详细介绍
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 Version Manager)安装和管理 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— 提供全部操作(共 418 项)的统一服务hostinger-agency-hosting-mcp— agency-hosting 的 42 项操作hostinger-agent-readiness-mcp— agent-readiness 的 3 项操作hostinger-billing-mcp— billing 的 9 项操作hostinger-dns-mcp— dns 的 8 项操作hostinger-domains-mcp— domains 的 42 项操作hostinger-ecommerce-mcp— ecommerce 的 29 项操作hostinger-horizons-mcp— horizons 的 6 项操作hostinger-hosting-mcp— hosting 的 68 项操作hostinger-mail-mcp— mail 的 38 项操作hostinger-reach-mcp— reach 的 69 项操作hostinger-vps-mcp— vps 的 67 项操作hostinger-wordpress-mcp— wordpress 的 40 项操作
每个二进制文件都提供相同的三个工具;范围限定的二进制文件只会搜索和执行其所属组的操作。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 代码。
OAuth 2.0 与 PKCE(交互式登录)
如果未设置 HOSTINGER_API_TOKEN,且服务以 stdio 模式运行,则会在首次经过身份验证的工具调用时自动使用 OAuth 2.0 与 PKCE:
- 向发行方注册一个动态 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 服务支持两种传输模式:
标准输入/输出传输
服务可以使用标准输入/输出(stdio)传输(默认)。此模式提供本地流式传输:
可流式传输的 HTTP 传输
服务可以使用 HTTP 流式传输。此模式通过 HTTP 提供双向流式传输:
# Default HTTP transport on localhost:8100
hostinger-api-mcp --http
# Specify custom host and port
hostinger-api-mcp --http --host 0.0.0.0 --port 8150
命令行选项
Options:
--http Use HTTP streaming transport (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 工具提供方
此服务实现了 Model Context Protocol(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 会被替换为先前步骤结果中的对应值。
操作
按二进制文件列出 search 提供的操作:
在同时提供替代工具的每个二进制文件中,已被较新工具取代的操作会从 search 中隐藏,也不会在文档中列出。在这些操作被移除之前,仍可通过 execute 使用。
hostinger-agency-hosting-mcp
agency-hosting_deploy-node-static-website
从归档文件部署 node-static Agency Plan(h5g)网站。警告:此操作会覆盖网站现有内容,且无法撤销——继续操作前务必先向用户确认。适用于 node-static 类型的 Agency Plan 网站(使用 Node.js 构建、需要构建步骤的静态网站,或简单的纯静态网站)。工具会根据域名解析网站,通过 TUS 将归档文件上传到网站的文件浏览器,并触发 build-assets 流程来构建网站并将结果部署到 public_html。此操作为同步操作:工具返回前,构建和部署就会完成,因此工具成功完成后网站即可上线——无需等待或轮询单独的异步构建。上传凭据会在内部生成并使用——不要单独调用 upload-url 端点,也不要自行上传归档文件;此工具会端到端完成整个流程。网站 UID 会根据域名自动解析。
- 方法:
custom - 路径:
custom
agency-hosting_deploy-php-application
从归档文件部署 PHP(或其他无需构建)Agency Plan(h5g)网站。警告:此操作会覆盖网站的现有内容,且无法撤销——继续操作前务必先与用户确认。对于需要直接解压并提供归档内容、无需构建步骤的 Agency Plan 网站,请使用此工具(例如 PHP 应用)。此工具会根据域名解析网站,通过 TUS 将归档上传到网站的文件管理器,并触发 import-archive 流程,以归档内容覆盖网站内容。此操作是同步的:工具返回前会完成归档解压和部署,因此工具成功完成后网站即已上线——无需等待或轮询单独的异步构建。上传凭据会自动生成并在内部使用——不要调用单独的 upload-url 端点,也不要自行上传归档;此工具会端到端完成整个过程。对于需要构建步骤的 node-static 网站,请改用 agency-hosting_deploy-node-static-website。网站 UID 会根据域名自动解析。
- 方法:
custom - 路径:
custom
agency-hosting_datacenters_list
列出给定 Agency Plan 托管订单中可用于配置新网站的数据中心。
每个数据中心都包含一个 pinger_url,可从客户端向其发送 ping,以测量往返延迟;比较各数据中心的结果,即可在创建网站配置时选择延迟最低、距离最近的数据中心,并将其 code 设为 datacenter_code。
- 方法:
GET - 路径:
/api/agency-hosting/v1/orders/{order_id}/datacenters
agency-hosting_domains_change-website
更改 Agency Plan 网站的主域名。
在路径中提供当前域名,并在请求正文中提供新域名。 将 domain 设为 null 可恢复为临时域名。
- 方法:
PUT - 路径:
/api/agency-hosting/v1/websites/{website_uid}/domains/{from_domain}
agency-hosting_domains_link-to-website
将域名关联到指定的 Agency Plan 网站,使其能够通过该域名提供流量服务。
- 方法:
POST - 路径:
/api/agency-hosting/v1/websites/{website_uid}/domains
agency-hosting_domains_list
返回经过身份验证的客户端可访问的 Agency Plan 网站所关联域名的分页列表。
使用 website_uuids 筛选器,将结果缩小到指定网站。
- 方法:
GET - 路径:
/api/agency-hosting/v1/domains
agency-hosting_domains_unlink-from-website
解除指定 Agency Plan 网站与某个域名的关联。
网站会立即停止通过该域名提供流量服务。
网站文件和数据库会保留,其他已关联的域名仍可访问。
如果这是网站唯一关联的域名,解除关联后,该网站将不再拥有可访问的域名。
- 方法:
DELETE - 路径:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}
agency-hosting_files_generate-upload-url
生成文件浏览器上传 URL 和身份验证凭据,用于将文件上传到 Agency Plan 网站的文件存储中。
返回 url、auth_key 和 rest_auth_key。使用这些信息,通过 TUS 可恢复上传协议(TUS 1.0.0)将文件上传到网站的文件存储中。在以下每个请求中都要发送 X-Auth: {auth_key} 和 X-Auth-Rest: {rest_auth_key} 标头。
- 创建上传:向
{url}/{relative_file_path}?override=true发送POST请求,并附带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
从已上传的归档文件导入 Agency Plan 网站。
请先通过文件浏览器将归档文件上传到网站的根目录,然后在此请求中提供其文件名。归档文件中的内容会覆盖网站现有内容。支持的归档类型:.zip、.tar、.tar.gz、.tgz。
- 方法:
POST - 路径:
/api/agency-hosting/v1/websites/{website_uid}/files/import-archive
agency-hosting_metrics_list-plan-order-disk-usage
返回所选时间范围内 Agency Plan 订单的磁盘和 inode 使用量汇总,以及套餐配额。数据涵盖整个订单账户。数值可能最多延迟一小时。CPU、内存和进程使用量请参阅资源使用指标端点。
- 方法:
GET - 路径:
/api/agency-hosting/v1/orders/{order_id}/disk-usage-metrics
agency-hosting_orders_list
返回已通过身份验证的客户端可访问的 Agency Plan 订单分页列表。
- 方法:
GET - 路径:
/api/agency-hosting/v1/orders
agency-hosting_metrics_list-order-resource-usage
返回所选时间范围内 Agency Plan 订单的 CPU、内存和进程使用量汇总,以及套餐配额和按网站划分的明细。每个网站通过 uid 标识。已暂停和已删除的网站不会计入订单总量或按网站划分的明细。数值可能最多延迟一小时。磁盘和 inode 使用量请参阅磁盘使用指标端点。
- 方法:
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 值替换为提供的值。请求中未包含的选项都会重置为默认值,因此请先调用选项端点,再发送完整的目标选项集。发送空数组会将所有选项重置为默认值。
- Method:
PUT - Path:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/options
agency-hosting_php_list-versions-for-order
列出为 Agency Plan 订单创建的网站可用的 PHP 版本,具体版本取决于托管该订单的服务器。创建网站前请调用此端点;对于已存在的网站,请改为调用网站范围的版本端点。
- Method:
GET - Path:
/api/agency-hosting/v1/orders/{order_id}/websites/php-settings/versions
agency-hosting_php_list-versions-for-website
列出 Agency Plan 网站可切换到的 PHP 版本。网站当前运行的版本会由网站详情端点作为 settings.php.version 返回。
- Method:
GET - Path:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/versions
agency-hosting_php_update-website-version
将 Agency Plan 网站切换到其他 PHP 版本。请先调用可用版本端点,查看可选版本。网站会使用新版本重新启动,因此切换期间处理的请求可能会失败,与目标版本不兼容的代码也会无法运行。
- Method:
PATCH - Path:
/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。配置完成后,新网站即可访问。
- Method:
POST - Path:
/api/agency-hosting/v1/orders/{order_id}/websites/setups
agency-hosting_website-setups_status
返回通过设置端点启动的 Agency Plan 网站配置任务的当前状态。
使用配置请求返回的 setup_uuid 轮询此端点,直到 status 变为 completed。此时,website_uid 即为新网站的标识符。
- Method:
GET - Path:
/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。
- Method:
POST - Path:
/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。
- 方法:
POST - 路径:
/api/agency-hosting/v1/websites/{website_uid}/cron-jobs
agency-hosting_cron-jobs_delete-website
永久删除 Agency Plan 网站中由其 uuid 标识的 cron job。
此操作具有幂等性:删除不存在的 cron job 时会成功,且不会报错。
- Method:
DELETE - Path:
/api/agency-hosting/v1/websites/{website_uid}/cron-jobs/{uuid}
agency-hosting_databases_list-website
返回为 Agency Plan 网站创建的 MySQL 数据库的分页列表。
每个条目都包含该数据库的非系统用户。
- Method:
GET - Path:
/api/agency-hosting/v1/websites/{website_uid}/databases
agency-hosting_databases_create-website
为 Agency Plan 网站创建一个 MySQL 数据库及其专用用户。
调用方必须提供数据库名称、用户名和密码。
- Method:
POST - Path:
/api/agency-hosting/v1/websites/{website_uid}/databases
agency-hosting_databases_delete-website
从 Agency Plan 网站永久删除 MySQL 数据库及其所有数据,包括数据库用户。
此操作具有幂等性:删除不存在的数据库时会成功,且不会报错。
- Method:
DELETE - Path:
/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}
agency-hosting_databases_create-website-user
为 Agency Plan 网站上的现有数据库创建用户。
每个数据库仅支持一个非系统用户;为已有用户的数据库创建用户会失败。
- Method:
POST - Path:
/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}/users
agency-hosting_databases_delete-website-user
从 Agency Plan 网站数据库中永久删除数据库用户,并撤销该用户的所有访问权限。
此操作具有幂等性:删除不存在的用户时会成功,且不会报错。
- Method:
DELETE - Path:
/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}/users/{database_user_name}
agency-hosting_websites_get
获取特定 Agency Plan 网站的详细信息,包括配置、状态、元数据、托管方案详情和资源配额。
- Method:
GET - Path:
/api/agency-hosting/v1/websites/{website_uid}
agency-hosting_websites_delete
永久删除 Agency Plan 网站。删除操作异步处理:网站会立即进入删除状态,底层服务器资源则会在后台移除。
- Method:
DELETE - Path:
/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 获取更精确的结果。
- Method:
GET - Path:
/api/agency-hosting/v1/websites
agency-hosting_websites_list-processes
列出 Agency Plan 网站正在进行和最近完成的异步进程。
每个进程都有唯一 ID(用于跟踪)、类型和状态(运行中、已完成、失败)。启动异步操作(SSL 设置、备份、克隆)后,可轮询此端点以跟踪进度。
- Method:
GET - Path:
/api/agency-hosting/v1/websites/{website_uid}/processes
agency-hosting_wordpress_change-version
将 Agency Plan 网站上安装的 WordPress 核心版本更改为可供安装的版本之一。
- Method:
PATCH - Path:
/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings/version
agency-hosting_wordpress_settings
返回 Agency Plan 网站的当前 WordPress 设置:已安装的核心版本、LiteSpeed Cache 插件状态、对象缓存状态和维护模式状态。
- Method:
GET - Path:
/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings
agency-hosting_wordpress_list-versions
列出可在 Agency Plan 网站上安装的 WordPress 核心版本。
- Method:
GET - Path:
/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings/versions
hostinger-agent-readiness-mcp
agent-readiness_checks_list
列出 Agent 就绪度扫描运行的所有检查,以及每项检查的名称、类别和权重。\n
用于显示扫描结果中每个 check_id 对应的易读名称。
- Method:
GET - Path:
/api/agent-readiness/v1/checks
agent-readiness_scans_run
开始扫描公共网站对 AI Agent 的可发现性、可读性和可操作性。\n
扫描以异步方式运行:此操作仅启动扫描,返回的扫描通常处于 pending 状态,尚无结果。若要获取结果,请每隔几秒使用相同的域名轮询“获取 Agent 就绪度扫描”操作,直至状态变为 completed 或 failed。扫描本身最长运行 60 秒,另加可能的队列等待时间。failed 状态的扫描不会重试;请重新运行此操作。\n
如果某个域名在过去 5 分钟内已有待处理扫描,则启动扫描时会返回该扫描,而不会启动新的扫描。
- Method:
POST - Path:
/api/agent-readiness/v1/scans
agent-readiness_scans_get
获取网站最新的 Agent 就绪度扫描。\n
使用 Run agent readiness scan 操作启动的扫描以异步方式运行。状态为 pending 时,结果字段为 null;请等待几秒后再次调用此操作,直至状态变为 completed 或 failed。failed 状态的扫描不会重试;请重新运行扫描。\n
已完成的扫描会提供 0-100 的分数、字母等级、各类别的分数,以及每项检查的结果、找到的证据和修复方法。检查名称由 List checks 操作列出。\n
如果域名从未扫描过,则返回 404;请先使用 Run agent readiness scan 操作。
- Method:
GET - Path:
/api/agent-readiness/v1/scans/{domain}
hostinger-billing-mcp
billing_catalog_list
获取可供订购的目录项目。
目录项目的价格以分为单位显示(不使用浮点数),
例如:浮点数 17.99 显示为整数 1799。
在下单前,使用此端点查看可用服务和价格。
- Method:
GET - Path:
/api/billing/v1/catalog
billing_orders_create-purchase
为任意 Hostinger 产品创建购买订单。
此统一端点可为一个或多个目录项目下单,
适用于所有 Hostinger 产品,并利用现有的账单基础设施。使用目录端点查找可购买的 item_id 值。
如果未提供付款方式,将自动使用默认付款方式。
如果响应为 202 Accepted,则付款仍在处理中;确认付款后,订单将异步完成。
此端点仅用于下单。此处不会进行特定产品的配置 (例如 VPS 设置或域名注册)。订单完成后,请使用相应的产品端点或 hPanel 完成设置。
使用此端点购买目录中提供的任意产品。
- Method:
POST - Path:
/api/billing/v1/orders
billing_payment-methods_set-default
设置账户的默认付款方式。
使用此端点为后续订单配置主要付款方式。
- Method:
POST - Path:
/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 订阅创建续订订单。
此端点会利用现有账单基础设施,为单个订阅下续订订单。使用
subscriptions endpoint 查找可用于续订的
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 恢复为原始配置。
- Method:
POST - Path:
/api/dns/v1/zones/{domain}/reset
dns_records_validate
在更新所选域名的 DNS 记录前进行验证。
如果验证成功,响应将包含 200 Success 代码。
如果验证失败,响应将返回 422 Validation error 代码。
使用此端点可在应用更改前验证 DNS 记录是否有效。
- Method:
POST - Path:
/api/dns/v1/zones/{domain}/validate
hostinger-domains-mcp
domains_verifications_direct
获取待处理和已完成的域名验证列表。
- Method:
GET - Path:
/api/v2/direct/verifications/active
domains_availability_suggest-names-from-description
根据项目的自由文本描述推荐可用的域名。
建议由 AI 模型生成,因此每次调用的结果都不同。
端点的速率限制为每分钟 90 次请求。
如果你只知道网站的主题,可使用此端点查找域名。
- Method:
POST - Path:
/api/domains/v1/availability/alternatives-from-description
domains_availability_suggest-names-from
根据你已有想法的域名推荐可用的域名。
建议由 AI 模型生成,因此每次调用的结果都不同。
端点的速率限制为每分钟 90 次请求。
如果你想要的域名已被注册,需要查找相近的替代名称,可使用此端点。
- Method:
POST - Path:
/api/domains/v1/availability/alternatives-from-domain
domains_availability_check
检查多个 TLD 下的域名是否可用。
可以一次检查多个 TLD。
如果希望响应中包含替代域名,请仅提供一个 TLD,并将 with_alternatives 设为 true。
提供的 TLD 不应带前导点(例如 com、net、org)。
端点的速率限制为每分钟 90 次请求。
购买前可使用此端点确认域名是否可用。
- Method:
POST - Path:
/api/domains/v1/availability
domains_forwarding_get
获取域名转发数据。
使用此端点查看域名当前的重定向配置。
- Method:
GET - Path:
/api/domains/v1/forwarding/{domain}
domains_forwarding_update
更新域名转发配置。
使用此端点修改域名现有的重定向配置。
- Method:
PUT - Path:
/api/domains/v1/forwarding/{domain}
domains_forwarding_delete
删除域名转发数据。
使用此端点移除域名的重定向配置。
- Method:
DELETE - Path:
/api/domains/v1/forwarding/{domain}
domains_forwarding_create
创建域名转发配置。
使用此端点设置将域名重定向到其他 URL。
- Method:
POST - Path:
/api/domains/v1/forwarding
domains_whois_pending-irtp-verification
获取域名待处理的 IRTP 验证。
WHOIS 更改生效前,原注册人和新注册人都必须确认。
使用此端点查看等待注册人确认的 WHOIS 更改状态。
- Method:
GET - Path:
/api/domains/v1/irtp/{domain}
domains_whois_cancel-pending-irtp-verification
取消待处理的 IRTP 验证。
如果 WHOIS 更改因等待注册人确认而受阻,可使用此端点撤销更改; 例如,确认邮件无法收到时,无需等待 5 天过期即可撤销。
- Method:
DELETE - Path:
/api/domains/v1/irtp/{domain}
domains_move_incoming
获取指定域名的转入请求。
如果没有账户正在将此域名转入你的账户,则返回 404。
使用此端点可检查转入到你的域名是否仍在等待接受。
- Method:
GET - Path:
/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 状态码。
受高级保护保护的域名需要额外的验证步骤,此类请求会被拒绝并返回 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 配置文件。该配置文件必须存在,并且信息完整且适用于该 TLD。配置文件不完整是域名处于等待设置状态的最常见原因。请使用 Create WHOIS profile 创建配置文件。
某些 TLD 需要 additional_details。这些信息会在设置前进行验证,因此,如果缺少所需值或值无效,系统会拒绝请求,不会尝试注册。
域名将使用默认名称服务器和隐私保护进行设置。之后可使用 Update domain nameservers 和 Disable 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 保持商品目录、订单、配送和付款信息同步。
- Method:
GET - Path:
/api/ecommerce/v1/miscellaneous/custom-storefront-instructions
ecommerce_orders_cancel
取消订单,并可选择向客户发送邮件。返回更新后的订单摘要。
- Method:
POST - Path:
/api/ecommerce/v1/stores/{store_id}/orders/{order_id}/cancel
ecommerce_orders_fulfil
为订单创建履约并一次性附加跟踪信息。省略商品项即可履约所有剩余的未履约商品项。返回更新后的订单摘要。
- Method:
POST - Path:
/api/ecommerce/v1/stores/{store_id}/orders/{order_id}/fulfill
ecommerce_orders_list-store
按时间从新到旧列出商店订单摘要。可按状态、付款或履约状态、客户邮箱、订单编号或自由文本查询进行筛选。金额以最小货币单位表示。获取单个订单可查看其商品项、地址和履约信息。
- Method:
GET - Path:
/api/ecommerce/v1/stores/{store_id}/orders
ecommerce_orders_retrieve
完整获取单个订单:商品项(每项都包含履约端点所需的 ID)、地址、总额明细,以及含跟踪信息的履约记录。金额以最小货币单位表示。
- Method:
GET - Path:
/api/ecommerce/v1/stores/{store_id}/orders/{order_id}
ecommerce_payments_enable-manual-method
启用手动付款方式,让商店无需在线支付服务提供商也能接收订单。
- Method:
POST - Path:
/api/ecommerce/v1/stores/{store_id}/payment-methods/manual
ecommerce_payments_create-provider-connect-link
创建用于将支付网关连接到商店的入驻链接。返回商家可打开的网关入驻 URL,以及指向商店管理后台的深层链接。
- Method:
POST - Path:
/api/ecommerce/v1/stores/{store_id}/payment-providers/{provider_id}/connect-link
ecommerce_payments_list-store-providers
列出商店的支付服务提供商,分为已连接到商店的提供商和可安装的网关。绝不公开网关凭据、密钥或配置。
- Method:
GET - Path:
/api/ecommerce/v1/stores/{store_id}/payment-providers
ecommerce_products_create-image-upload-url
返回用于上传商品图片的签名 URL(multipart/form-data POST)。随后调用附加图片端点,并传入返回的 object_name,以扫描图片并将其附加到商品。
- Method:
POST - Path:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/images/upload-url
ecommerce_products_delete
从商店删除商品及其变体。若订阅商品有活跃订阅者,则会将其归档而非删除,以保留其数据。
- Method:
DELETE - Path:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}
ecommerce_products_update
更新商品名称、描述、状态、SEO 设置或系列。将状态设为 published 可使商品可购买,设为 draft 可将其隐藏,设为 archived 则可将其停用。省略的 SEO 设置(标题、描述、slug)将保留原值。collection_changes 可添加或移除系列,而不影响其他系列。变体、价格和库存通过变体端点管理,不在此处管理。返回更新后的商品摘要。
- Method:
PATCH - Path:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}
ecommerce_products_create-digital
创建一件已发布的数字商品,包含单个变体和一个可选的外部下载链接。
- Method:
POST - Path:
/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),并通过一次调用将其附加到商品。图像下载必须使用 443 端口上的 HTTPS,且 URL 不得包含嵌入式凭据。最多允许一次重定向,且重定向目标必须符合相同要求。系统会拒绝指向私有或保留网络地址的目标、不受支持的 URL 以及包含多次重定向的链接。图像会经过病毒扫描和内容验证,然后存储到 CDN。将 is_thumbnail 设为 true 可将图像设为商品的主图。
- 方法:
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
沿一个或多个选项维度(例如 Size、Color)为产品添加变体。产品中缺少的选项会自动创建;对于产品已有的每个选项,都必须提供一个值。价格为以最小货币单位表示的整数,默认为商店货币。返回创建的变体。
- 方法:
POST - 路径:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants
hostinger-horizons-mcp
horizons_websites_clone
将 Hostinger Horizons 网站克隆为一个新网站。\n
当用户想要复制现有网站时,请使用此工具,例如在不影响原网站的情况下尝试更改。\n
此工具会返回新创建副本的 ID 和 URL。
原网站不会受到影响。\n
如需编辑副本,请使用返回的网站 ID 调用 Edit website 工具,或者用户可以在 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
调用此工具后,你的聊天回复必须恰好为 1 句话,概述 Hostinger Horizons 正在创建他们的网站,几分钟后即可完成,并且你应立即向用户提供网站 URL。
不要编写代码。\n\n如需之后编辑,请使用返回的网站 ID 调用 Edit website 工具,或者用户可以通过提供的网站 URL 访问 Hostinger Horizons 界面。
如果工具调用因错误而失败,请清楚说明错误,不要在聊天中自行生成代码。
\n
技术栈限制(严格执行):\n
环境仅支持以下技术。
严禁使用、建议或实现此列表之外的任何技术:\n
\n
-
语言:仅限 JavaScript。
-
严禁使用 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 调用此工具后,你的聊天回复必须恰好为 1 句话,概述 Hostinger Horizons 正在应用所请求的更改,并且几分钟后即可完成,同时应立即向用户提供网站 URL。 不要编写代码。\n 如果工具调用失败并返回错误,应向用户清楚说明错误,不要在聊天中自行生成代码。
- 方法:
POST - 路径:
/api/horizons/v1/websites/{websiteId}/messages
horizons_websites_publish
发布 Hostinger Horizons 网站,使其最新更改上线。\n
当用户要求发布、部署或让网站上线时,请使用此工具。\n
此工具会启动发布流程,并返回网站上线后使用的 URL。
发布过程为异步操作,需要几分钟。\n
只有在用户明确要求将网站作为模板分享时,才设置 is_template:设为 true 会在已发布页面上添加“Use template”横幅,访客可通过该横幅将网站复制到自己的账户中;设为 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 表示已发布页面是否显示“Use template”横幅,has_ecommerce_store 表示网站是否有在线商店。\n
可以使用 Edit website 工具编辑网站,用户也可以通过提供的网站 URL 在 Hostinger Horizons 界面中编辑网站。
- 方法:
GET - 路径:
/api/horizons/v1/websites/{websiteId}
hostinger-hosting-mcp
hosting_deploy
将网站部署、发布或上传到 Hostinger 虚拟主机(Shared、Cloud):可以是静态 HTML、PHP、nodejs(Node.js)应用、整个 WordPress 网站,也可以是 WordPress 插件或主题;来源可以是本地目录、压缩包或 GitHub、GitLab 仓库。它会自动检测项目类型,并自行完成上传、构建和 Git 设置:不要调用上传或构建操作,也不要自行压缩目录。警告:此操作会覆盖网站内容且无法撤销;如果要部署到已有内容的网站,请先向用户确认域名。Node.js 构建会在服务器上运行:此调用会立即返回 buildUuid,然后调用 hosting_get-deployment,直到构建状态变为 completed 或 failed。插件或主题会部署到网站的 WordPress 安装中,即使 WordPress 位于文档根目录的某个文件夹中(无头模式)也不例外。静态网站、PHP、插件和主题在此调用返回时即部署完成;导入 WordPress 网站则只是开始导入,几分钟后才会解压文件。从 Git 部署时,除非网站已经运行 Node.js 应用,或你传入了 Node.js 设置,否则请传入 type(static 或 nodejs);静态或 PHP 网站会立即部署该分支,并在每次推送时再次部署;Node.js 网站会立即构建该分支,并在之后每次推送时再次构建,设置会保存到网站中(如果尚未保存设置,则会从分支的 package.json 中检测;传入 appType、nodeVersion、outputDirectory、buildScript 或 entryFile 可覆盖这些设置)。使用 Git 前,需要在 hPanel 中连接一次 GitHub 或 GitLab。
- 方法:
custom - 路径:
custom
hosting_get-deployment
检查网站 Node.js 部署的部署状态、构建状态、构建日志以及构建失败原因(失败分析):包括最新构建(或 buildUuid 对应构建)的状态、构建日志末尾内容、构建失败时的失败分析,以及为网站保存的构建设置和 Git 自动部署设置。在 hosting_deploy 启动 Node.js 构建后使用此工具,也可用它查明部署失败的原因。逐渐延长间隔轮询,直到构建状态变为 completed 或 failed。返回完整日志;传入 fromLine(从上一次调用算起的行数),即可只读取新增输出。对于没有 Node.js 构建的网站,会返回 build: null 和说明,因为静态网站、PHP、插件和主题会在 hosting_deploy 返回时部署完成,而 WordPress 网站导入会在开始几分钟后就绪。
- 方法:
custom - 路径:
custom
hosting_websites_trigger-event
告知 Hostinger 该网站发生了某项事件,以便 hPanel 等 Hostinger 服务对此作出响应。event.name 用于选择事件,并决定 event.params 需要哪些参数。此调用不会更改网站上的任何内容。
- 方法:
custom - 路径:
custom
hosting_cache_clear-website
一次性永久清除该网站的所有服务器端缓存。内容更新后需要立即显示,或进行重大更改后,可使用此工具。
如果网站已启用 CDN,还会清除 Hostinger CDN 缓存。若只清除 CDN 缓存而保留服务器缓存,请使用 Purge CDN cache。对于位于子目录中的 WordPress 安装,请传入 directory 查询参数以清除其缓存。
- 方法:
DELETE - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/cache/clear
hosting_cache_status
返回网站的缓存状态:服务器端缓存是否已启用,以及开发(无缓存)模式是否已开启。适用于账户的主域名、附加网站、停放域名和子域名;每个网站都会报告自己的设置,不会继承父网站的设置。
is_enabled 是由 Toggle website cache 更改的设置,会立即反映切换状态。开发模式开启时,is_cacheless_mode_enabled 为 true;此时即使 is_enabled 为 true,也会绕过缓存。Toggle cacheless mode 会在后台应用,因此此标志可能需要几分钟才会更新。
域名必须与账户中列出的网站名称完全一致,且不能带有 www. 前缀。如果该域名不是账户中的网站,则返回 404。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/cache/status
hosting_cache_toggle-cacheless
根据 enabled 标志开启或关闭开发(无缓存)模式。启用后不会缓存任何内容,相当于关闭网站的所有缓存;可在积极开发、测试更改、调试问题或需要实时显示更新时使用。完成开发工作后请将其关闭,以恢复缓存带来的性能优势。
更改会在后台应用,可能需要几分钟。使用 Get cache status 检查当前状态。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/cacheless-mode/toggle
hosting_cache_toggle-website
根据 enabled 标志开启或关闭网站的服务器端缓存。启用后可加快页面加载速度、降低服务器负载并改善用户体验;建议在生产网站上启用。关闭缓存可能会影响性能;开发或调试期间若要临时绕过缓存,建议切换无缓存模式。
如果缓存已处于请求的状态,则不执行任何操作。使用 Get cache status 检查当前状态。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/cache/toggle
hosting_cdn_disable
关闭网站域名的 Hostinger CDN。DNS 传播完成后,网站内容将由源服务器直接提供。可安全地重复调用;如果 CDN 已关闭,则会再次应用 DNS 更改。
对于由平台管理的域名(例如 *.hostingersite.com 和 *.app-preview.com),即使 CDN 已关闭,也会返回 422,因为无法关闭 CDN。如果账户正在迁移到另一台服务器(请在迁移完成后重试),或 CDN 提供商拒绝更改,也会返回 422。如果该域名不是账户中的网站,则返回 404。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/cdn/disable
hosting_cdn_enable
为网站域名开启 Hostinger CDN,以加快页面加载速度并降低服务器负载。适用于账户的主域名、停放域名和子域名。
启用时会更改域名的 DNS 记录,通常需要几秒钟。之后,DNS 传播可能还需要几分钟,访客才能通过 CDN 访问网站。
可安全地重复调用,例如在超时后重试。如果 CDN 已启用,则会再次应用 DNS 更改并刷新 CDN SSL 证书。
如果账户已停用、账户正在迁移到另一台服务器(请在迁移完成后重试),或 CDN 提供商拒绝更改,则返回 422。如果该域名不是账户中的网站,则返回 404。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/cdn/enable
hosting_cdn_purge-cache
仅清除 Hostinger CDN 边缘缓存中的网站内容,不会清除源服务器缓存;如需同时清除两者,请使用 Clear website cache。
如果网站未启用 CDN,则返回 422。如果该域名不是此账户下的网站,则返回 404。
- 方法:
DELETE - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/cdn/purge
hosting_cdn_status
返回此网站域名是否已启用 Hostinger CDN。支持账户的主域名、停放域名和子域名。
域名必须与账户中列出的网站名称完全一致,且不能带有 www. 前缀。如果该域名不是此账户下的网站,则返回 404。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/cdn/status
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
更改指定数据库用户的密码。
数据库名称必须使用列出数据库的端点返回的完整名称。还必须更新任何使用此数据库的网站配置中的密码。
- 方法:
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 地址,或 %,与列出远程连接接口返回的值完全一致)。数据库名称必须是列出数据库接口返回的完整名称。
- Method:
DELETE - Path:
/api/hosting/v1/accounts/{username}/databases/{name}/remote-connections
hosting_databases_list-remote-connections
返回指定账户的远程访问规则:允许连接到账户数据库的远程主机(IPv4/IPv6 地址,或表示任意主机的 %)。
使用域名筛选条件,仅返回分配给特定域名的数据库规则。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/databases/remote-connections
hosting_databases_repair
异步修复损坏的数据库表。
在报告数据库错误、崩溃或损坏时使用。 数据库名称必须是列出数据库接口返回的完整名称。
- Method:
PATCH - Path:
/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,其中 user 和 password 经过百分号编码)。
保留现有变量。如果网站已有任何同名变量,调用将失败并返回 422,且不会创建任何内容;Replace Node.js environment variables 接口会将其移除。
调用后,这些变量就是普通环境变量:Replace Node.js environment variables 接口可以像处理其他变量一样更改或移除它们。
对于在进程启动时读取环境变量的应用(例如 Express 或 NestJS),重启即可。对于将变量烘焙进构建输出的框架(Next.js、NEXT_PUBLIC_*),只有执行全新构建后才会读取新值(使用 Start Node.js build 接口)。
请求中提供的密码会被忽略;平台始终会生成密码。可选的 name 和 user 是标识符,而非机密信息。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/databases/setup
hosting_databases_phpmyadmin-link
返回指定数据库的 phpMyAdmin 直接登录链接。
需要使用可视化数据库界面执行 SQL 查询、导入、导出或管理表时,可使用此接口。 数据库名称必须是列出数据库接口返回的完整名称。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/databases/{name}/phpmyadmin-link
hosting_datacenters_list
根据可用的数据中心容量和订单中的主机套餐,获取可用于设置主机套餐的数据中心列表。 列表中的第一项最符合您的订单需求。
- Method:
GET - Path:
/api/hosting/v1/datacenters
hosting_domains_generate-free-subdomain
生成一个唯一的免费子域名,可用于主机服务,无需购买自定义域名。 免费子域名可让您立即开始使用主机服务,之后也可以随时为网站连接自定义域名。
- Method:
POST - Path:
/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_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_delete-auto-deployment-settings
删除网站的 Git 自动部署设置。已部署的文件会保留在网站上;在重新保存设置之前, 推送操作将不再触发部署。即使未配置任何设置,此操作也会成功。
- 方法:
DELETE - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/git/auto-deployments/settings
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-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 文件或用户提示词中的真实值。
- Method:
PUT - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/settings/env
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 列表。
- Method:
GET - Path:
/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。
- Method:
DELETE - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/runtime-logs
hosting_nodejs_restart-application
重启网站的 Node.js 服务器进程。不会重新构建或重新部署应用。可用于应用环境或配置更改,或恢复卡死的应用。
仅适用于服务端应用(Express、Next.js、NestJS 等)。静态前端应用(React、Vue、Vite)没有持久运行的服务器进程,因此重启不会产生任何效果。即使网站没有可重启的服务器进程,也会返回成功。
- Method:
POST - Path:
/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 的漏洞已包含在一个未关闭的补丁拉取请求中;只要有任何补丁拉取请求处于打开状态,在该请求合并或关闭之前,系统都会拒绝为此网站创建新的补丁请求。
数据来自定期依赖项扫描,因此可能无法反映最新部署的情况。列表为空表示最近一次扫描未发现漏洞,但不保证当前部署不存在漏洞。Business 和 Cloud Hosting 套餐可用。
- 方法:
GET - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/vulnerabilities
hosting_nodejs_patch-vulnerabilities
通过更新 package.json 中受影响的软件包版本,并在已连接的仓库中打开 GitHub 拉取请求,修补选定的 Node.js 漏洞。客户审核并合并该拉取请求;合并后会触发自动部署。
自动修复仅适用于从已连接的 GitHub 仓库部署的网站。从存档部署的网站没有自动修复途径,会返回 404。Hostinger GitHub App 需要拥有仓库的写入权限;如果没有该权限,请求将失败并返回 403,说明缺少相应权限。
只有 is_patchable 设为 true 的漏洞才能修补。所选漏洞中的不可修补 ID 会被跳过;拉取请求仅涵盖可修补的漏洞,并在 patched_vulnerability_ids 中列出。如果所选漏洞中没有任何可修补项,请求将被拒绝并返回 422。每个网站一次只能有一个未关闭的补丁拉取请求;再次修补前,请先关闭或合并该请求。Business 和 Cloud Hosting 套餐可用。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/vulnerabilities/patch
hosting_websites_list-setups
按从新到旧的顺序,返回最近 24 小时内为已认证客户端可访问的托管账户启动的网站设置任务。可使用 order_id、subscription_id 或 domain 筛选列表。
此端点适合在创建网站或启动网站设置后立即轮询:网站会先出现在网站列表中,而服务器端设置可能尚未完成;设置处于 running 状态时,对该网站执行操作的端点可能会返回 404 或 409。每隔 10 到 15 秒使用 domain 筛选条件轮询此端点,并等待 status: completed 后再上传文件、部署或创建数据库。failed 表示设置在完成前停止,或超过一小时未报告进度。超过 24 小时的设置任务不会列出。
type 是启动设置时指定的网站类型(wordpress、headless_empty、headless_wordpress、headless_ecommerce、headless_pocketbase);空网站则为 null。
- 方法:
GET - 路径:
/api/hosting/v1/onboardings
hosting_websites_start-setup
在 Web 或 Cloud 托管订单上启动网站设置,并立即返回已创建的设置;网站本身会异步配置。每隔 10 到 15
秒使用 domain 筛选条件轮询网站设置列表端点(hosting_websites_list-setups),并等待
status: completed 后再上传文件、部署或创建数据库。
对于空网站,请省略 type。type: wordpress 会在网站根目录中安装 WordPress,并使用
wordpress 中的管理员用户名、电子邮件和密码,以域名作为站点标题;如果省略
wordpress.language,则使用 en_US。无头类型
(headless_empty、headless_wordpress、headless_ecommerce、headless_pocketbase)
会创建无头网站;headless_wordpress 还会在网站根目录的
cms 目录中安装 WordPress,并生成凭据。headless_empty 不会安装任何内容:之后可通过
POST /api/hosting/v1/accounts/{username}/wordpress/installations
(wordpress_installations_install),并使用 type: headless 添加 WordPress。
省略 domain,即可在生成的临时免费子域名上设置网站。若要在调用前知道免费子域名,以便在调用超时后查询并在同一域名上重试,请通过
POST /api/hosting/v1/domains/free-subdomains
(hosting_domains_generate-free-subdomain)生成子域名,并将其作为 domain 发送。该子域名仅接受
24 小时,且只能由生成它的客户端使用。
如果订单还没有托管账户,设置流程会先创建一个账户,数据中心为 datacenter_code 指定的数据中心;若省略该参数,则使用订单的默认数据中心。
如果订单不存在,或已通过身份验证的客户端无权访问,则返回 404;如果同一域名的设置仍在进行中,则返回带有 Retry-After 标头的 409。
- 方法:
POST - 路径:
/api/hosting/v1/orders/{order_id}/onboardings
hosting_orders_list
获取已通过身份验证的客户端可访问的订单分页列表。
仅列出 Web 和 Cloud 托管订单。Agency Plan 订单通过
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 扩展(模块)。
更改扩展前,请使用 Get PHP details 端点检查当前扩展状态。
- 方法:
PATCH - 路径:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/extensions
hosting_php_update-options
更新网站的 PHP 选项(例如 memory_limit、max_execution_time、upload_max_filesize)。
只需在 options 对象中提供要更改的选项。
超过账户套餐限制的值会被静默限制为该上限,因此请求可能会成功,但实际应用的值更小。之后请调用 Get PHP details 端点读取实际应用的值。
- Method:
PATCH - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/options
hosting_php_update-version
更改网站的 PHP 版本。
使用 Get PHP details 端点查看该网站可用的版本。
- Method:
PATCH - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/version
hosting_redirects_list-website
返回所选网站已配置重定向的分页列表。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/redirects
hosting_redirects_create-website
创建从所选网站上的某个 URL 重定向到另一个 URL 或 IP 地址的规则。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/redirects
hosting_redirects_delete-website
永久删除由其源 URL 标识的重定向。
传入的 from 值必须与 list redirects 端点返回的值完全一致。
- Method:
DELETE - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/redirects
hosting_ssl_install
为网站申请终身 SSL 证书。安装将在后台运行;安装结束后,Get SSL status 会报告 active 或 failed。如果已有 active 的终身证书,请求仍会继续:系统会申请重新安装证书。
对于免费子域名(其证书由平台管理)、安装状态为 installing 或 waiting_for_retry、网站证书已被撤销(无法重新签发),以及已安装上传的自定义证书的情况,端点会返回 422;对于自定义证书,必须先将其卸载。
- Method:
POST - Path:
/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。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/ssl/status
hosting_ssl_toggle-https-redirect
根据 is_enabled 开启或关闭网站的 HTTP 到 HTTPS 重定向。如果重定向已处于所请求的状态,则不执行任何操作。开启重定向需要已安装证书(Get SSL status 中的 status 为 active 或 expired);如果没有证书,则返回 422。关闭重定向始终会被接受。
- Method:
PATCH - Path:
/api/hosting/v1/accounts/{username}/websites/{domain}/ssl/https-redirect/toggle
hosting_ssl_uninstall
移除分配给该网站的 SSL 证书,关闭 HTTPS 重定向,并取消待处理的安装重试。完成新的安装前,网站将通过普通 HTTP 提供服务。调用返回后,Get SSL status 会立即报告 not_installed;即使未分配证书,调用也会成功,因此可以安全地重复调用。
对于免费子域名(其证书由平台管理)以及安装状态为 installing 时,返回 422。
- Method:
DELETE - Path:
/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 反映的是暂停状态,并非就绪状态。若要了解新创建的网站何时可以执行文件、部署或数据库操作,请轮询网站设置列表端点。
- Method:
GET - Path:
/api/hosting/v1/websites
hosting_websites_create
已弃用:请改用 POST /api/hosting/v1/orders/{order_id}/onboardings(开始网站设置)。该端点接受相同的 domain 和 datacenter_code,还可以安装 WordPress,并返回已创建的设置。
为经过身份验证的客户端创建新网站。
必须选择用于创建此网站的托管订单。将该订单与域名一同作为 order_id 传入。列出订单即可查看可用 ID;网站将在该订单的托管方案上配置。
仅接受 Web 和 Cloud 托管订单。若要在 Agency Plan 订单上创建网站,请使用 POST /api/agency-hosting/v1/orders/{order_id}/websites/setups。
如果订单尚无托管账户,则会先创建一个托管账户,使用 datacenter_code 指定的数据中心;如果未提供,则使用订单的默认数据中心。之后的网站将自动托管在同一数据中心。
网站创建为异步操作,最多需要几分钟。每隔 10 到 15 秒轮询一次带有 domain 筛选条件的网站设置列表端点,并等待 status: completed 后再上传文件、部署或创建数据库。设置状态为 running 时,操作该网站的端点可能会返回 404 或 409。网站列表中的 is_enabled 反映的是暂停状态,并非就绪状态。
- Method:
POST - Path:
/api/hosting/v1/websites
hosting_websites_delete
此端点会永久删除网站及其所有数据。此操作无法撤销。调用前,请确保用户了解相关后果,并明确确认要继续。
所有网站文件、数据库和相关配置都会被删除。 托管方案本身会保留,因此之后可以在该方案上创建新网站。
支持的网站:虚拟主机方案上的主域名和附加域名网站,以及 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
获取邮件订单中的邮箱分页列表。
使用此接口监控邮件服务中的邮箱,包括其状态、已启用的协议、关联的资源数量,以及定期同步的用量数据(用量可能会滞后于实时数据)。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/mailboxes
mail_mailboxes_create-mailbox
在指定的邮件订单下创建邮箱。完整的电子邮件地址由给定的本地部分和订单的域名组成。
- Method:
POST - Path:
/api/mail/v1/orders/{orderId}/mailboxes
mail_mailboxes_delete-mailbox
删除邮箱。邮箱会被软删除,并在有限期限内保持可恢复状态,之后才会被永久移除。
- Method:
DELETE - Path:
/api/mail/v1/mailboxes/{mailboxId}
mail_mailboxes_change-mailbox-password
更改邮箱密码。
- Method:
PATCH - Path:
/api/mail/v1/mailboxes/{mailboxId}/password
mail_orders_list
获取与您的帐户关联的邮件订单分页列表。
使用此接口监控邮件服务,包括其状态、套餐、关联域名和到期详情。
- Method:
GET - Path:
/api/mail/v1/orders
mail_orders_plan
获取指定邮件订单购买时使用的套餐,包括域名级和邮箱级配额、限制及协议可用情况。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/plan
mail_webhooks_create
为指定邮箱创建 webhook。生成的密钥仅在此响应中返回,并会作为持有者令牌随每次投递发送。
- Method:
POST - Path:
/api/mail/v1/mailboxes/{mailboxId}/webhooks
mail_webhooks_list-delivery-logs
获取指定邮件订单的 webhook 投递日志分页列表,包括投递结果、耗时和重试次数。支持按邮箱筛选。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/webhooks/delivery-logs
mail_webhooks_get
获取单个 webhook 的详情。不会包含 webhook 密钥;该密钥仅在创建 webhook 或重新生成其密钥时返回。
- Method:
GET - Path:
/api/mail/v1/webhooks/{webhookId}
mail_webhooks_delete
永久删除 webhook。此操作无法撤销。删除后,该 URL 将不再接收事件通知。
- Method:
DELETE - Path:
/api/mail/v1/webhooks/{webhookId}
mail_webhooks_update
部分更新 webhook。仅更改请求正文中包含的字段;省略的字段保留当前值。传入 "description": null 可清除描述。
- Method:
PATCH - Path:
/api/mail/v1/webhooks/{webhookId}
mail_webhooks_list
获取指定邮件订单中 webhook 的分页列表。支持按邮箱和状态筛选。不会包含 webhook 密钥;该密钥仅在创建 webhook 或重新生成其密钥时返回。
- Method:
GET - Path:
/api/mail/v1/orders/{orderId}/webhooks
mail_webhooks_regenerate-secret
重新生成 webhook 的密钥。旧密钥会立即失效。新密钥仅在此响应中返回,并会作为持有者令牌随每次投递发送。
- Method:
POST - Path:
/api/mail/v1/webhooks/{webhookId}/regenerate-secret
mail_webhooks_test
向 webhook URL 发送测试投递并返回结果。测试请求会受到上游速率限制。
- Method:
POST - Path:
/api/mail/v1/webhooks/{webhookId}/test
hostinger-reach-mcp
reach_automations_get
获取单个自动化,并查看进入其中、正在执行、已完成或中途失败的联系人数。
此接口描述自动化本身。若要查看其运行的工作流,请使用步骤端点。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}
reach_automations_list
获取个人资料中自动化的分页列表。
每个自动化都会附带进入其中、正在执行、已完成或中途失败的联系人数。这些数量描述的是联系人的旅程,并非电子邮件互动指标。如需查看打开、点击和退订数据,请改用营销活动统计端点。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/automations
reach_automations_list-steps
以扁平步骤列表的形式获取自动化工作流。
这些步骤构成树状结构,而非直线流程:通过 parent_uuid 重建分支,并使用 step_order 对具有相同父级的步骤排序。尚无步骤的自动化会返回空列表。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}/steps
reach_campaigns_get
获取单个营销活动及其发件人、主题、模板引用、定向设置和发送进度。
此接口描述营销活动的设置方式及其当前进度。如需查看打开、点击和退订数据,请使用营销活动统计端点。此处不包含电子邮件内容:将 template_uuid 传递给获取电子邮件模板端点,即可读取其 HTML。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}
reach_campaigns_list
获取个人资料中营销活动的分页列表。
每个营销活动都会附带主要互动率。按状态筛选可查找草稿、已安排、发送中或已发送的营销活动;请注意,完全发送完毕的营销活动状态为 publish。默认情况下只返回常规营销活动;传递 type 可获取自动化发送的电子邮件或双重选择加入确认邮件。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/campaigns
reach_campaigns_create-draft
在个人资料中创建营销活动。
营销活动将以草稿形式创建,因此不会发送任何内容,也不会触达任何联系人。它也尚未设置受众:此请求不包含定向和计划安排;草稿需要在 Reach 界面中完成并发送。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/campaigns
reach_campaigns_performance
获取营销活动的表现数据:投递、打开、点击和退订情况及对应比率。
所有数量统计的都是唯一联系人,而非原始事件。因此,同一联系人打开同一封电子邮件五次,也只计为一次。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics
reach_contacts_delete
删除指定 UUID 的联系人。
此端点会从电子邮件营销系统中永久删除联系人。
已弃用。 此端点无法指定个人资料,因此始终使用客户端的默认个人资料,也无法删除其他个人资料中的联系人。请改用 DELETE /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}。
- Method:
DELETE - Path:
/api/reach/v1/contacts/{uuid}
reach_contact-fields_delete
删除自定义联系人字段。
该字段中所有联系人的值都会一并删除;对于选项类型,其选项也会一并删除。联系人本身不受影响。
- Method:
DELETE - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/fields/{fieldUuid}
reach_contact-fields_update
重命名自定义联系人字段;对于选项类型字段,还可替换其选项集。
带有 uuid 的选项会保留并更新标签,没有 uuid 的选项会被创建;未包含在列表中的现有选项会被删除,联系人为其保存的值也会一并删除。字段类型和 slug 无法更改。
- Method:
PATCH - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/fields/{fieldUuid}
reach_contact-fields_list
获取配置文件中定义的自定义联系人字段。
自定义字段可让你在联系人上存储自己的属性。返回的 uuid 可用于通过联系人更新端点设置值;选项字段还会列出可供选择的选项。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/fields
reach_contact-fields_create
在配置文件中定义新的自定义联系人字段。
slug 根据标签生成,且与字段类型一样,之后无法更改。使用返回的 uuid 可为联系人设置值。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/fields
reach_contacts_list-groups
获取所有联系人分组的列表。
此端点会返回联系人分组列表,可用于整理联系人。
- Method:
GET - Path:
/api/reach/v1/contacts/groups
reach_contacts_list
获取联系人列表,可选择按分组和订阅状态筛选。
此端点会返回包含联系人基本信息的分页列表。你可以按分组 UUID 和订阅状态筛选联系人。
已弃用。 此端点无法指定配置文件,因此始终回退到客户端的默认配置文件,也无法列出其他配置文件中的联系人。请改用
GET /api/reach/v1/profiles/{profileUuid}/contacts,该端点还会以标签筛选取代分组筛选。
- Method:
GET - Path:
/api/reach/v1/contacts
reach_contacts_create
在电子邮件营销系统中创建新联系人。
此端点允许你创建新联系人,并填写姓名、电子邮件地址和姓氏等基本信息。
如果启用了双重确认订阅, 联系人会以待确认状态创建,并收到一封确认邮件。
- Method:
POST - Path:
/api/reach/v1/contacts
reach_contacts_get
获取单个联系人的完整详细信息。
除了联系人的自身属性外,此端点还会返回分配给联系人的标签,以及联系人为配置文件自定义联系人字段保存的值。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}
reach_contacts_delete-profile
从配置文件中永久删除联系人。
该联系人及其自定义字段值和标签分配都会一并移除。
- Method:
DELETE - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}
reach_contacts_update
更新联系人的属性和自定义字段值。
只有请求正文中包含的属性会被更改,因此只需提供部分正文即可更改单个属性。将属性设为 null 可清除该属性。
响应会返回联系人的核心属性。若要读取其标签、自定义字段值、来源和备注,请调用
GET /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}。
- Method:
PATCH - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}
reach_contacts_create-in-bulk
通过单次调用在配置文件中批量创建联系人。
联系人会在后台导入,因此成功响应表示已接受导入请求,而非导入已完成。电子邮件地址已存在于配置文件中的联系人会保留当前值;只有仍为空的字段(包括自定义字段)才会被填充。如果启用了双重确认订阅,新联系人会以待确认状态开始,并收到一封确认邮件。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/contacts/bulk
reach_contacts_list-profile
获取属于某个资料的联系人分页列表。
可以按订阅状态、标签和电子邮件搜索词筛选联系人。
响应中的 meta.total 字段表示符合筛选条件的联系人数量,
因此,不带筛选条件调用此端点会返回该资料的联系人总数。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/contacts
reach_contacts_create-bulk
在电子邮件营销系统中创建联系人。
此端点允许你创建联系人,并提供姓名、电子邮件和姓氏等基本信息。
如果启用了双重选择加入,联系人将以待确认状态创建, 系统也会发送确认电子邮件。
- Method:
POST - Path:
/api/reach/v1/profiles/{profileUuid}/contacts
reach_segments_list
获取所有联系人细分群组的列表。
此端点会返回联系人细分群组列表,可用于整理联系人。
已弃用。 此端点无法指定资料,因此始终回退到客户端的默认资料,无法列出其他资料的细分群组。请改用
GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments。
- Method:
GET - Path:
/api/reach/v1/segmentation/segments
reach_segments_create
创建新的联系人细分群组。
此端点允许创建新的联系人细分群组,用于整理联系人。 可以根据电子邮件、姓名、订阅状态等特定条件配置细分群组。
已弃用。 此端点无法指定资料,因此始终回退到客户端的默认资料,无法在其他资料中创建细分群组。请改用
POST /api/reach/v1/profiles/{profileUuid}/segmentation/segments。
- Method:
POST - Path:
/api/reach/v1/segmentation/segments
reach_segments_count-profile-contacts
统计当前符合某个细分群组条件的联系人数量,而不列出联系人。
只需获取数量时,比通过联系人细分群组端点分页查询更省资源。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/count
reach_segments_list-profile-contacts
获取指定资料中与某个细分群组关联的联系人。
此端点允许你获取并筛选属于特定细分群组的联系人, 该细分群组由其 UUID 标识,并限定在指定资料范围内。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts
reach_segments_profile
获取某个资料的单个细分群组,包括定义该群组的条件。
如需获取当前符合这些条件的联系人,请改用细分群组联系人端点。
- Method:
GET - Path:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}
reach_segments_update-profile
重命名细分群组和/或替换定义该群组的条件。
name 为必填项。省略 conditions 可在不更改条件的情况下重命名;提供 conditions 则会完全替换现有条件,而不是与其合并。
联系人本身不会被修改,但符合细分群组条件的联系人可能会立即发生变化。
- Method:
PUT - Path:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}
reach_segments_delete-profile
删除细分群组。
只会移除细分群组定义,符合该群组条件的联系人不会受到影响。
- Method:
DELETE - Path:
/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_update
重命名表单和/或更改其状态。
将 draft 或 paused 状态的表单设为 active,即可使其上线:系统会发布最近保存的设计,访客也可以提交表单。paused 和 draft 状态会阻止表单接受提交。表单上线后,访客才能访问。表单处于 active 状态时保存的设计更改不会发布,除非先暂停表单,再次将其设为 active。重命名不会更改自动生成的 form:{name} 标签。
- 方法:
PATCH - 路径:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}
reach_forms_duplicate
将表单复制为一个新的草稿表单,并保留相同的名称和设计。
副本会与源表单共用自动生成的 form:{name} 标签;不会复制其他提交者标签。将副本的状态设为 active 后,它才会上线。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}/duplicate
reach_forms_list
获取个人资料中注册表单的分页列表。
每个表单都引用了用于渲染它的模板。获取表单详情,以取得可直接使用的模板 URL,以及表单会为其收集的联系人添加的标签。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/forms
reach_forms_create
创建一个空白草稿表单。
Reach 还会自动添加 form:{name} 标签,所有提交者都会获得该标签。草稿没有设计,访客无法访问:使用更新表单模板操作保存设计,然后将表单状态设为 active,使其上线。创建表单不会消耗 AI 积分。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/forms
reach_forms_add-submitter-tags
为表单添加标签,使此后提交表单的每位联系人都获得这些标签。
表单已有的标签会被跳过;未知标签会被拒绝。此前提交过表单的联系人不会获得这些标签。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}/tags
reach_forms_remove-submitter-tag
停止为此后提交表单的联系人添加某个标签。
即使表单没有该标签,此操作也会成功。已获得该标签的联系人仍会保留该标签,标签本身也不会被删除。无法移除自动添加的 form:{name} 标签,尝试移除会引发冲突。
- 方法:
DELETE - 路径:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}/tags
reach_forms_update-template
将 content 保存为表单的最新设计,并返回已存储的版本。
HTML 会经过净化处理;除非套餐允许移除 Reach 标识,否则会添加该标识。访客提交表单时必须填写 email 字段,并可选填写 name、surname 和 phone。净化后,设计必须包含表单容器(data-reach-form)、电子邮件输入框(data-reach-field="email")和提交按钮(data-reach-submit);否则请求会失败并返回 422,且 errors.content 会列出 missing_form_container、missing_email_field 和/或 missing_submit_button。
draft 或 paused 状态的表单在状态设为 active 之前无法访问;设为 active 后,此设计会发布。对于已处于 active 状态的表单,保存的设计不会公开,除非先暂停表单,再将其设为 active。保存设计不会消耗 AI 积分。
- 方法:
PATCH - 路径:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}/template
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_integrations_disconnect-ecommerce-store
断开与此资料关联的电商商店。
Reach 将不再接收该商店的客户和订单,并会从 Reach 中移除其产品和优惠券;联系人和历史订单会保留。从列出电商商店的端点获取 store_id;如果商店的状态为 connected_to_other_profile,则针对那个资料调用此端点。即使该商店未连接到此资料,此调用也会成功,因此成功并不能证明已断开连接。调用前,请与客户确认商店和套餐。
- 方法:
DELETE - 路径:
/api/reach/v1/profiles/{profileUuid}/ecommerce/stores/{storeId}
reach_integrations_list-ecommerce-stores
获取客户的所有 Hostinger 电商商店,每个商店都包含其 store_id 和相对于路径中资料的 connection_status。
每个商店最多只能连接到一个资料。connected_to_other_profile 不会指出该资料是哪一个——请针对每个资料调用此端点以查找。无法访问电商服务时,列表会为空,而不会返回错误。将 store_id 传递给断开电商商店的端点。连接 AI Website Builder 网站时,会连接在该网站上销售的商店。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/ecommerce/stores
reach_templates_list-email
获取资料中的电子邮件模板列表,按最近更新时间从新到旧排序。
模板是营销活动所用的可重复使用的电子邮件正文。列表不会分页,且只返回元数据,不包含 HTML 内容。创建营销活动时,将模板的 uuid 用作 template_uuid。若要读取某个模板的 HTML,请使用获取电子邮件模板的端点,并且仅在确实需要内容时调用。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/templates
reach_templates_create-email
在资料中创建电子邮件模板。
模板存放营销活动可重复使用的 HTML 正文,因此可以在创建任何营销活动之前创建。响应只会返回模板元数据——请保留返回的 uuid,以便在营销活动中将其用作 template_uuid。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/templates
reach_templates_email
获取资料中的一个电子邮件模板及其完整 HTML,HTML 位于 template_content 中。
营销活动的电子邮件内容就是其模板:若要查看营销活动会发送的内容,请获取该营销活动,并将其 template_uuid 传递给此端点。HTML 可能很大,因此仅在确实需要内容时才获取,切勿用它来浏览或挑选模板——列出电子邮件模板的端点可以在不返回内容的情况下完成此操作。诸如 {{name}} 的个性化标签会以未渲染的形式返回。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/templates/{templateUuid}
reach_integrations_list-connected-websites
获取与资料连接的网站,每个网站都包含其 domain 和 platform_type。
每个域名最多只能连接到一个资料,因此若要查明网站使用的是哪个套餐,请针对每个资料调用此端点。这里只会列出已连接的网站,而不是客户拥有的所有网站;电商商店也不包含在内——请使用列出电商商店的端点获取。将 domain 传递给断开 WordPress 网站或断开 AI Website Builder 网站的端点。
- 方法:
GET - 路径:
/api/reach/v1/profiles/{profileUuid}/websites
reach_integrations_connect-ai-website-builder-site
将客户手动创建的 AI Website Builder 网站连接到个人资料,让订阅者流入 Reach。
如果客户没有拥有该域名的 AI Website Builder 网站,则会因未找到而失败。
如果该域名已连接到任何个人资料,则会返回 DOMAIN_ALREADY_EXISTS;若要将网站移至其他套餐,请先从旧个人资料中断开连接。如果此个人资料已有 AI Website Builder 网站,则会返回
WEBSITE_CONNECTION_ALREADY_EXISTS。
如果网站上销售的 eCommerce 商店尚未连接到任何位置,也会一并连接。
此处无法连接 WordPress 网站,以及使用 agentic AI Website Builder 创建的网站。
- 方法:
POST - 路径:
/api/reach/v1/profiles/{profileUuid}/websites/website-builder
reach_integrations_disconnect-ai-website-builder-site
从个人资料中断开 AI Website Builder 网站;该网站将停止向 Reach 发送订阅者。
从已连接网站列表端点获取 domain。适用于已在构建器中删除的网站。如果该域名未连接到此个人资料,则会因未找到而失败。联系人和任何已连接的 eCommerce 商店会保留。网站会保持断开状态,直到再次连接,因此调用前请与客户确认网站和套餐。
- 方法:
DELETE - 路径:
/api/reach/v1/profiles/{profileUuid}/websites/website-builder
reach_integrations_disconnect-wordpress-site
从个人资料中断开 WordPress 网站。
该网站上的 Reach 插件将停止发送订阅者和商店数据,网站的产品和优惠券也会从 Reach 中移除;联系人和历史订单会保留。从已连接网站列表端点获取 domain。如果该域名未连接到此个人资料,则会因未找到而失败。此操作无法通过 API 撤销;客户需从 WordPress 插件重新连接,因此调用前请与客户确认网站和套餐。
- 方法:
DELETE - 路径:
/api/reach/v1/profiles/{profileUuid}/websites/wordpress
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 可以是格式为 https://github.com/[user]/[repo] 的 Github 仓库 URL,系统会自动解析到 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
已弃用:账户级公钥没有直接的替代方案。现在通过
DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys 按虚拟机管理 Root SSH 密钥。
从您的账户中删除公钥。
从账户中删除公钥不会将其从虚拟机中移除
使用此端点从账户中移除未使用的 SSH 密钥。
- 方法:
DELETE - 路径:
/api/vps/v1/public-keys/{publicKeyId}
vps_public-keys_list
已弃用:账户级公钥没有直接的替代方案。现在通过
GET /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys 按虚拟机管理 Root SSH 密钥。
获取与您的账户关联的公钥。
使用此端点查看可用于 VPS 身份验证的 SSH 密钥。
- 方法:
GET - 路径:
/api/vps/v1/public-keys
vps_public-keys_create
已弃用:账户级公钥没有直接的替代方案。现在通过
POST /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys 按虚拟机管理 Root SSH 密钥。
向您的账户添加新的公钥。
使用此端点注册用于 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 安装(software)标识符。可通过 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 安装(software)标识符。可通过 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 安装(software)标识符。可通过 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 安装(software)标识符。可通过 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 安装(software)标识符。可通过 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/installations/check-is-valid
wordpress_installations_delete
删除指定的 WordPress 安装,可选择同时移除文件和数据库。这会移除所有关联组件,包括插件、主题、暂存网站及其他相关数据。
请在路径中提供 WordPress 安装(software)标识符。可通过 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/orders/{order_id}/onboardings
(hosting_websites_start-setup),然后轮询 GET /api/hosting/v1/onboardings
(hosting_websites_list-setups),并使用 domain 筛选条件,直到其 status 为
completed。
发送 type: headless,可将无头网站(例如使用 hosting_websites_start-setup 并设置
type: headless_empty 创建的网站)转换为无头 WordPress 网站:WordPress 会安装到
cms 目录中,并配置 Hostinger 无头 MU 插件,同时将网站标记为无头 WordPress 网站。
此时不允许使用 directory。目标网站必须已经是无头网站:无头安装会重写根目录下的
.htaccess,因此在其他类型的网站上,系统会以 422 错误拒绝请求。
继续操作前,请调用 GET /api/hosting/v1/wordpress/installations(wordpress_installations_list),
并按用户名和域名筛选,以检查目标域名/路径上是否已安装 WordPress。如果 WordPress
已存在且 overwrite 为 false(默认值),异步任务将失败。
此操作为异步操作:成功响应仅表示安装任务已加入队列,并不表示 WordPress 已准备就绪。
安装通常需要 1-2 分钟。请轮询 GET /api/hosting/v1/wordpress/installations
(wordpress_installations_list),并按用户名和域名筛选,以跟踪进度。当安装出现在该列表中时,
WordPress 即已准备就绪。
如果账户已使用完套餐允许的所有数据库,则返回 422;但若 database.name 是账户上已有的数据库,则不会返回 422。
- 方法:
POST - 路径:
/api/hosting/v1/accounts/{username}/wordpress/installations
wordpress_installations_list
列出经过身份验证的客户端可访问的共享和云 Web 托管账户(/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 字段)。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/version
wordpress_installations_update-core
更新指定安装的 WordPress 核心(小版本更新或更新到特定版本)。
请在路径中提供 WordPress 安装(软件)标识符。可从 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
此操作为异步操作:成功响应仅表示更新任务已加入队列。
- Method:
POST - Path:
/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 字段)。
- Method:
POST - Path:
/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 字段)。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/litespeed-cache/status
wordpress_login_create-links
为指定 WordPress 安装创建临时自动登录链接。
请在路径中提供 WordPress 安装(软件)标识符。可从 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/login/links
wordpress_maintenance_show-status
显示指定 WordPress 安装的维护模式状态。
请在路径中提供 WordPress 安装(软件)标识符。可从 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- Method:
GET - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/maintenance/status
wordpress_maintenance_toggle
根据 enabled 标志,为指定 WordPress 安装启用或禁用维护模式。
请在路径中提供 WordPress 安装(软件)标识符。可从 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
- Method**:
PATCH - Path:
/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 字段)。
- Method:
GET - Path:
/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 字段)。
- Method:
PATCH - Path:
/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 字段)。
此操作为异步操作:成功响应仅表示卸载任务已加入队列。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes/uninstall
wordpress_themes_update
将 WordPress 安装中一个或多个已安装主题更新到最新版本。
请在路径中提供 WordPress 安装(软件)标识符。可从 GET /api/hosting/v1/wordpress/installations 获取(id 字段)。
此操作为异步操作:成功响应仅表示更新任务已加入队列。
- Method:
POST - Path:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes/update
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。