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.
Domeinen
Domeinen, verificatie, DNS-status, setup-sleutels en domeinwerkruimten beheren. De voorbeelden gebruiken de A2A-codemodus. MCP biedt dezelfde codemodus via het hulpmiddelexecute.
Functies
domains.delete
domains.delete.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | domain.delete | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | domain.delete |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | DELETE /v1/public/accounts/{account_id}/domains/{domain} |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
domain | str | ja |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
result | {} | ja |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
domains.get
domains.get.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | domain.view | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | domain.view |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | GET /v1/public/accounts/{account_id}/domains/{domain} |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
domain | str | ja |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
id | str | ja |
name | str | ja |
outbound_routing_ready | bool | ja |
status | str | ja |
workspace_id | str | ja |
auto_renew | bool | nee |
created_at | str | null | nee |
dedicated_ip_id | str | null | nee |
dns_records | [{"id": int, "name": str, "ttl": int, "type": str, "value": str, "is_system_managed"?: bool, "priority"?: int | null}] | nee |
inbound_tenant_external_id | str | null | nee |
inbound_tenant_id | str | null | nee |
inbound_tenant_name | str | null | nee |
inbound_tenant_type | str | null | nee |
mailboxes | [{"active": bool, "email": str, "first_name": str, "id": str, "last_name": str}] | nee |
redirect_mode | "301" | "302" | "iframe" | null | nee |
redirect_url | str | null | nee |
tags | [{"id": str, "name": str}] | nee |
updated_at | str | null | nee |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
domains.health
domains.health.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | domain.view | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | domain.view |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | GET /v1/public/accounts/{account_id}/domains/{domain}/health |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
domain | str | ja |
refresh | bool | nee |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
cache_ttl_seconds | int | ja |
cached | bool | ja |
checked_at | str | ja |
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}} | ja |
domain_id | str | ja |
domain_name | str | ja |
summary_status | "healthy" | "warning" | "critical" | "unknown" | ja |
timings_ms | {} | ja |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
domains.list
domains.list.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | domain.view | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | domain.view |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | GET /v1/public/accounts/{account_id}/domains |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
page | int | nee |
page_size | int | nee |
search | str | null | nee |
workspace_id | str | null | nee |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
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}] | ja |
page | int | ja |
page_size | int | ja |
total | int | ja |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
domains.move
domains.move.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | domain.move | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | domain.move |
| Resourcetype | workspace | Resource-ID-veld | target_workspace_id |
| Openbare API-route | POST /v1/public/accounts/{account_id}/domains/{domain}/move |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
domain | str | ja |
target_workspace_id | str | ja |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
account_id | str | ja |
domain_id | str | ja |
domain_name | str | ja |
from_workspace_id | str | ja |
reconciled | {"linked_records_changed"?: int} | ja |
to_workspace_id | str | ja |
status | str | nee |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
domains.purchase
domains.purchase.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | domain.purchase | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | domain.purchase |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | POST /v1/public/accounts/{account_id}/domains/purchase |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
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} | ja |
domains | [str] | ja |
workspace_id | str | ja |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
results | [{"domain_name": str, "status": str, "error"?: str | null, "error_code"?: str | null, "id"?: str | null}] | ja |
currency | str | null | nee |
estimated_total | str | null | nee |
failed_count | int | nee |
payment_url | str | null | nee |
purchase_batch_id | str | null | nee |
successful_count | int | nee |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
domains.search
domains.search.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | domain.create | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | domain.create |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | GET /v1/public/accounts/{account_id}/domains/search |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
domains | [str] | ja |
workspace_id | str | ja |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
available | bool | ja |
domain | str | ja |
price | str | ja |
alternatives | [{"domain": str, "price": str, "available"?: bool, "currency"?: str, "is_premium"?: bool, "is_suggestion"?: bool}] | nee |
currency | str | nee |
is_premium | bool | nee |
is_suggestion | bool | nee |
unavailable_reason | str | null | nee |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
domains.update
domains.update.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | domain.update | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | domain.update |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | PATCH /v1/public/accounts/{account_id}/domains/{domain} |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
domain | str | ja |
auto_renew | bool | null | nee |
redirect_mode | "301" | "302" | "iframe" | null | nee |
redirect_url | str | null | nee |
workspace_id | str | null | nee |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
auto_renew | bool | ja |
id | str | ja |
workspace_id | str | ja |
redirect_mode | "301" | "302" | "iframe" | null | nee |
redirect_url | str | null | nee |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
domains.verify
domains.verify.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | domain.verify | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | domain.verify |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | POST /v1/public/accounts/{account_id}/domains/{domain}/verify |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
domain | str | ja |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
actual_nameservers | [str] | ja |
domain_id | str | ja |
expected_nameservers | [str] | ja |
message | str | ja |
status | str | ja |
verified | bool | ja |
missing_nameservers | [str] | nee |
unexpected_nameservers | [str] | nee |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons: