Domains

Get Domain

CLI:

agentmail domains get --domain-id <domain_id>
get/v0/domains/{domain_id}

Path parameters

domain_idstring required

The ID of the domain.

Response

pod_idstring

ID of pod.

domain_idstring required

The ID of the domain.

domainstring required

The name of the domain (e.g., example.com).

status'NOT_STARTED' | 'PENDING' | 'INVALID' | 'FAILED' | 'VERIFYING' | 'VERIFIED' required
feedback_enabledboolean required

Bounce and complaint notifications are sent to your inboxes.

subdomains_enabledboolean required

Allow inboxes on any subdomain of this domain. Adds a required wildcard MX record (*.<domain>) to records.

client_idstring

Client ID of domain.

updated_atstring date-time required

Time at which the domain was last updated.

created_atstring date-time required

Time at which the domain was created.

Changes

Changed in 4 of the 34 revisions of this API.4618

    • added the optional property code to the response with the 404 status

      response-optional-property-added

    • added the optional property docs to the response with the 404 status

      response-optional-property-added

    • added the optional property fix to the response with the 404 status

      response-optional-property-added

    • added the required property subdomains_enabled to the response with the 200 status

      response-required-property-added

  • 27965096e61817See the full diff
    • the status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • removed the FAILED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the INVALID enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the NOT_STARTED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the PENDING enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the VERIFIED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the VERIFYING enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • added the required property domain to the response with the 200 status

      response-required-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8a5b5e92ae2d26See the full diff
    • the status response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • removed the required property domain from the response with the 200 status

      response-required-property-removed

    • added the new FAILED enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new INVALID enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new NOT_STARTED enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new PENDING enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new VERIFIED enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new VERIFYING enum value to the status response property for the response status 200

      response-property-enum-value-added

    This revision also has 28 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7fdcd6b4651f17See the full diff
    • the status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • removed the FAILED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the INVALID enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the NOT_STARTED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the PENDING enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the VERIFIED enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the VERIFYING enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • added the required property domain to the response with the 200 status

      response-required-property-added