Documentation Index
Fetch the complete documentation index at: https://docs.hybridbox.io/llms.txt
Use this file to discover all available pages before exploring further.
域名
管理域名、验证、DNS 状态、设置密钥和域名工作区。 示例使用 A2A 代码模式。MCP 通过execute 工具公开相同的代码模式。
函数
domains.delete
domains.delete.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | domain.delete | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | domain.delete |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | DELETE /v1/public/accounts/{account_id}/domains/{domain} |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
domain | str | 是 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
result | {} | 是 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
domains.get
domains.get.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | domain.view | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | domain.view |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | GET /v1/public/accounts/{account_id}/domains/{domain} |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
domain | str | 是 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
id | str | 是 |
name | str | 是 |
outbound_routing_ready | bool | 是 |
status | str | 是 |
workspace_id | str | 是 |
auto_renew | bool | 否 |
created_at | str | null | 否 |
dedicated_ip_id | str | null | 否 |
dns_records | [{"id": int, "name": str, "ttl": int, "type": str, "value": str, "is_system_managed"?: bool, "priority"?: int | null}] | 否 |
inbound_tenant_external_id | str | null | 否 |
inbound_tenant_id | str | null | 否 |
inbound_tenant_name | str | null | 否 |
inbound_tenant_type | str | null | 否 |
mailboxes | [{"active": bool, "email": str, "first_name": str, "id": str, "last_name": str}] | 否 |
redirect_mode | "301" | "302" | "iframe" | null | 否 |
redirect_url | str | null | 否 |
tags | [{"id": str, "name": str}] | 否 |
updated_at | str | null | 否 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
domains.health
domains.health.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | domain.view | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | domain.view |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | GET /v1/public/accounts/{account_id}/domains/{domain}/health |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
domain | str | 是 |
refresh | bool | 否 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
cache_ttl_seconds | int | 是 |
cached | bool | 是 |
checked_at | str | 是 |
checks | {"dns": {"status": "healthy" | "warning" | "critical" | "unknown", "a"?: {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null} | null, "dkim"?: {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null} | null, "dmarc"?: {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null} | null, "error"?: str | null, "mx"?: {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null} | null, "ns"?: {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null} | null, "spf"?: {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null} | null}, "ports": {"status": "healthy" | "warning" | "critical" | "unknown", "error"?: str | null, "imap_143"?: {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null} | null, "imaps_993"?: {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null} | null, "smtp_25"?: {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null} | null, "submission_587"?: {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null} | null}, "ssl": {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null}, "web": {"status": "healthy" | "warning" | "critical" | "unknown", "error"?: str | null, "http_root"?: {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null} | null, "http_www"?: {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null} | null, "https_root"?: {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null} | null, "https_www"?: {"status": "healthy" | "warning" | "critical" | "unknown", "actual"?: [str] | null, "code"?: str | null, "days_remaining"?: int | null, "error"?: str | null, "expected"?: [str] | null, "expires_at"?: str | null, "issuer"?: str | null, "record"?: str | null, "records"?: [str] | null, "status_code"?: int | null} | null}} | 是 |
domain_id | str | 是 |
domain_name | str | 是 |
summary_status | "healthy" | "warning" | "critical" | "unknown" | 是 |
timings_ms | {} | 是 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
domains.list
domains.list.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | domain.view | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | domain.view |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | GET /v1/public/accounts/{account_id}/domains |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
page | int | 否 |
page_size | int | 否 |
search | str | null | 否 |
workspace_id | str | null | 否 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
items | [{"id": str, "name": str, "outbound_routing_ready": bool, "status": str, "workspace_id": str, "auto_renew"?: bool, "created_at"?: str | null, "dedicated_ip_id"?: str | null, "inbound_tenant_external_id"?: str | null, "inbound_tenant_id"?: str | null, "inbound_tenant_name"?: str | null, "inbound_tenant_type"?: str | null, "redirect_mode"?: "301" | "302" | "iframe" | null, "redirect_url"?: str | null, "tags"?: [{"id": str, "name": str}], "updated_at"?: str | null}] | 是 |
page | int | 是 |
page_size | int | 是 |
total | int | 是 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
domains.move
domains.move.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | domain.move | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | domain.move |
| 资源类型 | workspace | 资源 ID 字段 | target_workspace_id |
| 公共 API 路由 | POST /v1/public/accounts/{account_id}/domains/{domain}/move |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
domain | str | 是 |
target_workspace_id | str | 是 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
domain_id | str | 是 |
domain_name | str | 是 |
from_workspace_id | str | 是 |
reconciled | {"linked_records_changed"?: int} | 是 |
to_workspace_id | str | 是 |
status | str | 否 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
domains.purchase
domains.purchase.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | domain.purchase | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | domain.purchase |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | POST /v1/public/accounts/{account_id}/domains/purchase |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
contact_info | {"address_1": str, "city": str, "country": str, "email": str, "first_name": str, "last_name": str, "organization": str, "phone": str, "state": str, "zip": str} | 是 |
domains | [str] | 是 |
workspace_id | str | 是 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
results | [{"domain_name": str, "status": str, "error"?: str | null, "error_code"?: str | null, "id"?: str | null}] | 是 |
currency | str | null | 否 |
estimated_total | str | null | 否 |
failed_count | int | 否 |
payment_url | str | null | 否 |
purchase_batch_id | str | null | 否 |
successful_count | int | 否 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
domains.search
domains.search.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | domain.create | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | domain.create |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | GET /v1/public/accounts/{account_id}/domains/search |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
domains | [str] | 是 |
workspace_id | str | 是 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
available | bool | 是 |
domain | str | 是 |
price | str | 是 |
alternatives | [{"domain": str, "price": str, "available"?: bool, "currency"?: str, "is_premium"?: bool, "is_suggestion"?: bool}] | 否 |
currency | str | 否 |
is_premium | bool | 否 |
is_suggestion | bool | 否 |
unavailable_reason | str | null | 否 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
domains.update
domains.update.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | domain.update | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | domain.update |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | PATCH /v1/public/accounts/{account_id}/domains/{domain} |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
domain | str | 是 |
auto_renew | bool | null | 否 |
redirect_mode | "301" | "302" | "iframe" | null | 否 |
redirect_url | str | null | 否 |
workspace_id | str | null | 否 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
auto_renew | bool | 是 |
id | str | 是 |
workspace_id | str | 是 |
redirect_mode | "301" | "302" | "iframe" | null | 否 |
redirect_url | str | null | 否 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
domains.verify
domains.verify.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | domain.verify | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | domain.verify |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | POST /v1/public/accounts/{account_id}/domains/{domain}/verify |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
domain | str | 是 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
actual_nameservers | [str] | 是 |
domain_id | str | 是 |
expected_nameservers | [str] | 是 |
message | str | 是 |
status | str | 是 |
verified | bool | 是 |
missing_nameservers | [str] | 否 |
unexpected_nameservers | [str] | 否 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应: