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 | حقل معرف المورد | 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 | حقل معرف المورد | 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 | حقل معرف المورد | 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 | حقل معرف المورد | 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 | حقل معرف المورد | 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 | حقل معرف المورد | 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 | حقل معرف المورد | 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 | حقل معرف المورد | 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 | حقل معرف المورد | 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
الطلب:الاستجابة: