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.
Domínios
Gerenciar domínios, verificação, status DNS, chaves de configuração e espaços de trabalho de domínio. Os exemplos usam o modo de código A2A. O MCP expõe o mesmo modo de código pela ferramentaexecute.
Funções
domains.delete
domains.delete.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | domain.delete | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | domain.delete |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | DELETE /v1/public/accounts/{account_id}/domains/{domain} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
domain | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
result | {} | sim |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
domains.get
domains.get.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | domain.view | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | domain.view |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | GET /v1/public/accounts/{account_id}/domains/{domain} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
domain | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
id | str | sim |
name | str | sim |
outbound_routing_ready | bool | sim |
status | str | sim |
workspace_id | str | sim |
auto_renew | bool | não |
created_at | str | null | não |
dedicated_ip_id | str | null | não |
dns_records | [{"id": int, "name": str, "ttl": int, "type": str, "value": str, "is_system_managed"?: bool, "priority"?: int | null}] | não |
inbound_tenant_external_id | str | null | não |
inbound_tenant_id | str | null | não |
inbound_tenant_name | str | null | não |
inbound_tenant_type | str | null | não |
mailboxes | [{"active": bool, "email": str, "first_name": str, "id": str, "last_name": str}] | não |
redirect_mode | "301" | "302" | "iframe" | null | não |
redirect_url | str | null | não |
tags | [{"id": str, "name": str}] | não |
updated_at | str | null | não |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
domains.health
domains.health.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | domain.view | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | domain.view |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | GET /v1/public/accounts/{account_id}/domains/{domain}/health |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
domain | str | sim |
refresh | bool | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
cache_ttl_seconds | int | sim |
cached | bool | sim |
checked_at | str | sim |
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}} | sim |
domain_id | str | sim |
domain_name | str | sim |
summary_status | "healthy" | "warning" | "critical" | "unknown" | sim |
timings_ms | {} | sim |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
domains.list
domains.list.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | domain.view | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | domain.view |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | GET /v1/public/accounts/{account_id}/domains |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
page | int | não |
page_size | int | não |
search | str | null | não |
workspace_id | str | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
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}] | sim |
page | int | sim |
page_size | int | sim |
total | int | sim |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
domains.move
domains.move.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | domain.move | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | domain.move |
| Tipo de recurso | workspace | Campo de ID do recurso | target_workspace_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/domains/{domain}/move |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
domain | str | sim |
target_workspace_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
domain_id | str | sim |
domain_name | str | sim |
from_workspace_id | str | sim |
reconciled | {"linked_records_changed"?: int} | sim |
to_workspace_id | str | sim |
status | str | não |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
domains.purchase
domains.purchase.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | domain.purchase | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | domain.purchase |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/domains/purchase |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
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} | sim |
domains | [str] | sim |
workspace_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
results | [{"domain_name": str, "status": str, "error"?: str | null, "error_code"?: str | null, "id"?: str | null}] | sim |
currency | str | null | não |
estimated_total | str | null | não |
failed_count | int | não |
payment_url | str | null | não |
purchase_batch_id | str | null | não |
successful_count | int | não |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
domains.search
domains.search.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | domain.create | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | domain.create |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | GET /v1/public/accounts/{account_id}/domains/search |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
domains | [str] | sim |
workspace_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
available | bool | sim |
domain | str | sim |
price | str | sim |
alternatives | [{"domain": str, "price": str, "available"?: bool, "currency"?: str, "is_premium"?: bool, "is_suggestion"?: bool}] | não |
currency | str | não |
is_premium | bool | não |
is_suggestion | bool | não |
unavailable_reason | str | null | não |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
domains.update
domains.update.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | domain.update | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | domain.update |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | PATCH /v1/public/accounts/{account_id}/domains/{domain} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
domain | str | sim |
auto_renew | bool | null | não |
redirect_mode | "301" | "302" | "iframe" | null | não |
redirect_url | str | null | não |
workspace_id | str | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
auto_renew | bool | sim |
id | str | sim |
workspace_id | str | sim |
redirect_mode | "301" | "302" | "iframe" | null | não |
redirect_url | str | null | não |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
domains.verify
domains.verify.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | domain.verify | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | domain.verify |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/domains/{domain}/verify |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
domain | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
actual_nameservers | [str] | sim |
domain_id | str | sim |
expected_nameservers | [str] | sim |
message | str | sim |
status | str | sim |
verified | bool | sim |
missing_nameservers | [str] | não |
unexpected_nameservers | [str] | não |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta: