> ## Documentation Index > Fetch the complete documentation index at: https://aisa.one/docs/llms.txt > Use this file to discover all available pages before exploring further. # Manage Domain > Retrieve, update, or delete a domain by its ID, including details such as verification status, DNS records, and notification settings. ## OpenAPI ````yaml openapi/zh/agentmail.json GET /apis/v1/agentmail/domains/{domain_id} openapi: 3.1.0 info: description: '' title: AgentMail API version: '1' x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-configured-paths: - /apis/v1/agentmail/api-keys - /apis/v1/agentmail/api-keys/{api_key_id} - /apis/v1/agentmail/domains - /apis/v1/agentmail/domains/{domain_id} - /apis/v1/agentmail/domains/{domain_id}/verify - /apis/v1/agentmail/domains/{domain_id}/zone-file - /apis/v1/agentmail/drafts - /apis/v1/agentmail/drafts/{draft_id} - /apis/v1/agentmail/drafts/{draft_id}/attachments/{attachment_id} - /apis/v1/agentmail/inboxes - /apis/v1/agentmail/inboxes/{inbox_id} - /apis/v1/agentmail/inboxes/{inbox_id}/api-keys - /apis/v1/agentmail/inboxes/{inbox_id}/api-keys/{api_key_id} - /apis/v1/agentmail/inboxes/{inbox_id}/drafts - /apis/v1/agentmail/inboxes/{inbox_id}/drafts/{draft_id} - >- /apis/v1/agentmail/inboxes/{inbox_id}/drafts/{draft_id}/attachments/{attachment_id} - /apis/v1/agentmail/inboxes/{inbox_id}/drafts/{draft_id}/send - /apis/v1/agentmail/inboxes/{inbox_id}/events - /apis/v1/agentmail/inboxes/{inbox_id}/lists/{direction}/{type} - /apis/v1/agentmail/inboxes/{inbox_id}/lists/{direction}/{type}/{entry} - /apis/v1/agentmail/inboxes/{inbox_id}/messages - /apis/v1/agentmail/inboxes/{inbox_id}/messages/send - /apis/v1/agentmail/inboxes/{inbox_id}/messages/{message_id} - >- /apis/v1/agentmail/inboxes/{inbox_id}/messages/{message_id}/attachments/{attachment_id} - /apis/v1/agentmail/inboxes/{inbox_id}/messages/{message_id}/forward - /apis/v1/agentmail/inboxes/{inbox_id}/messages/{message_id}/raw - /apis/v1/agentmail/inboxes/{inbox_id}/messages/{message_id}/reply - /apis/v1/agentmail/inboxes/{inbox_id}/messages/{message_id}/reply-all - /apis/v1/agentmail/inboxes/{inbox_id}/metrics - /apis/v1/agentmail/inboxes/{inbox_id}/threads - /apis/v1/agentmail/inboxes/{inbox_id}/threads/{thread_id} - >- /apis/v1/agentmail/inboxes/{inbox_id}/threads/{thread_id}/attachments/{attachment_id} - /apis/v1/agentmail/lists/{direction}/{type} - /apis/v1/agentmail/lists/{direction}/{type}/{entry} - /apis/v1/agentmail/metrics - /apis/v1/agentmail/threads - /apis/v1/agentmail/threads/{thread_id} - /apis/v1/agentmail/threads/{thread_id}/attachments/{attachment_id} x-aisa-document: facts_hash: 9255366d22784f8aaa8fdf77c4a8ba89a12379e2b6b68f21bfcf09360afd4e63 generator_version: '2' protocol_version: '1' schema_version: '1' composer_version: '13' response_pending: [] document_hash: sha256:964edddd7b367f2a812e1f909bbc3cb3afa07afdcbeb867c833fcb8ec9cd7905 x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-provider: agentmail x-aisa-catalogs: agentmail: title: AgentMail API description: '' x-aisa-document: facts_hash: 9255366d22784f8aaa8fdf77c4a8ba89a12379e2b6b68f21bfcf09360afd4e63 generator_version: '2' protocol_version: '1' schema_version: '1' x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote servers: - url: https://api.aisa.one security: - bearerAuth: [] paths: /apis/v1/agentmail/domains/{domain_id}: get: tags: - default summary: Manage Domain description: >- Retrieve, update, or delete a domain by its ID, including details such as verification status, DNS records, and notification settings. operationId: get_any_agentmail_apis_v1_agentmail_domains_domain_id parameters: - name: domain_id in: path required: true schema: type: string description: 域名的 ID。 title: DomainId responses: '200': description: 状态码为 200 的响应 content: application/json: schema: $ref: '#/components/schemas/ResponseD09F9471A0E8_domains_Domain' default: content: application/json: schema: {} description: >- Error response; upstream passthrough responses may use provider formats components: schemas: ResponseD09F9471A0E8_domains_Domain: type: object properties: pod_id: $ref: '#/components/schemas/ResponseD09F9471A0E8_pods_PodId' domain_id: $ref: '#/components/schemas/ResponseD09F9471A0E8_domains_DomainId' domain: $ref: '#/components/schemas/ResponseD09F9471A0E8_domains_DomainName' status: $ref: '#/components/schemas/ResponseD09F9471A0E8_domains_Status' reason: type: string description: >- Why the domain is not (yet) VERIFIED, when known. `dns_records_missing` / `dns_records_invalid` point at the DNS records. The `ses_*` values mean the records look right and sending-infrastructure validation has not converged: `ses_dkim_pending` / `ses_mail_from_pending` (still checking), `ses_dkim_temporary_failure` / `ses_mail_from_temporary_failure` (a transient error the infrastructure keeps retrying on its own — usually resolves without changes), `ses_dkim_failed` / `ses_mail_from_failed` (a terminal verdict; re-verify after fixing), `ses_dkim_not_started` / `ses_mail_from_not_started` (the attribute was never configured on the identity — re-verify to push it), and `ses_not_verified_for_sending`. Absent when VERIFIED. feedback_enabled: $ref: '#/components/schemas/ResponseD09F9471A0E8_domains_FeedbackEnabled' inbound_enabled: $ref: '#/components/schemas/ResponseD09F9471A0E8_domains_InboundEnabled' description: >- Absent on domains created before this field existed; those receive email. subdomains_enabled: $ref: '#/components/schemas/ResponseD09F9471A0E8_domains_SubdomainsEnabled' tracking_enabled: $ref: '#/components/schemas/ResponseD09F9471A0E8_domains_TrackingEnabled' records: type: array items: $ref: >- #/components/schemas/ResponseD09F9471A0E8_domains_VerificationRecord description: >- A list of DNS records required to verify the domain. Includes the apex MX record unless `inbound_enabled` is false, and a wildcard MX record (`*.`) when `subdomains_enabled` is true. client_id: $ref: '#/components/schemas/ResponseD09F9471A0E8_domains_ClientId' updated_at: type: string format: date-time description: 域名上次更新的时间。 created_at: type: string format: date-time description: 域名的创建时间。 required: - domain_id - domain - status - feedback_enabled - subdomains_enabled - tracking_enabled - records - updated_at - created_at title: Domain ResponseD09F9471A0E8_pods_PodId: type: string description: Pod ID。 title: PodId ResponseD09F9471A0E8_domains_DomainId: type: string description: 域名的 ID。 title: DomainId ResponseD09F9471A0E8_domains_DomainName: type: string description: 域名（例如 `example.com`）。 title: DomainName ResponseD09F9471A0E8_domains_Status: $ref: '#/components/schemas/ResponseD09F9471A0E8_domains_VerificationStatus' description: 域名的验证状态。 title: Status ResponseD09F9471A0E8_domains_FeedbackEnabled: type: boolean description: 退信和投诉通知将发送到您的收件箱。 title: FeedbackEnabled ResponseD09F9471A0E8_domains_InboundEnabled: type: boolean description: >- Receive email for this domain. Defaults to `true`. Set `false` for a send-only domain: the apex MX record is not required and is omitted from `records`, so the domain's existing email provider keeps receiving its mail. Inboxes on a send-only domain can still send. title: InboundEnabled ResponseD09F9471A0E8_domains_SubdomainsEnabled: type: boolean description: >- Allow inboxes on any subdomain of this domain. Adds a required wildcard MX record (`*.`) to `records`. title: SubdomainsEnabled ResponseD09F9471A0E8_domains_TrackingEnabled: type: boolean description: >- Serve open tracking pixels from this domain. Adds a required `link.` CNAME record to `records`, which must be published and verified before `track_opens` can be used on a send. title: TrackingEnabled ResponseD09F9471A0E8_domains_VerificationRecord: type: object properties: type: $ref: '#/components/schemas/ResponseD09F9471A0E8_domains_RecordType' description: DNS 记录的类型。 name: type: string description: 记录的名称或主机。 value: type: string description: 记录的值。 status: $ref: '#/components/schemas/ResponseD09F9471A0E8_domains_RecordStatus' description: 此特定记录的验证状态。 priority: type: integer description: MX 记录的优先级。 reason: type: string description: >- Why the record is INVALID, when known. `duplicate_records` means the expected value is present but extra records coexist at the same name; `value_mismatch` means a record exists but does not match the expected value. required: - type - name - value - status title: VerificationRecord ResponseD09F9471A0E8_domains_ClientId: type: string description: 域的客户端 ID。 title: ClientId ResponseD09F9471A0E8_domains_VerificationStatus: type: string enum: - NOT_STARTED - PENDING - INVALID - FAILED - VERIFYING - VERIFIED title: VerificationStatus ResponseD09F9471A0E8_domains_RecordType: type: string enum: - TXT - CNAME - MX title: RecordType ResponseD09F9471A0E8_domains_RecordStatus: type: string enum: - MISSING - INVALID - VALID title: RecordStatus securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.