Skip to main content

List domains

GET 
/domains

Fetch a list of all domains associated with this API key.

Request​

Query Parameters

    domains hostname[]

    A list of domains to fetch. If this parameter is present, only domains whose name matches an item in this list are returned.

    limit int32

    Possible values: <= 5000

    The maximum number of domains included in the response. If not specified, defaults to 10.

    offset int32

    Offset into the list of domains to return. If not specified, defaults to 0.

Responses​

Successfully found the domain

Schema

    domains

    undefined[]

    required

    A list of domains

  • Array [

    • domain hostnamerequired

    The domain name.

    subscriptionHandle stringrequired

    The subscription 'handle' that identifies the subscription that this domain should be provisioned against. Subscription handles can be retrieved from the /subscriptions endpoint.

    settings

    The abuse policy settings for the domain. These settings determine how spam messages are handled.

    abusePolicy stringnullable

    The abuse policy

    Possible values: non-empty, [block, flag, quarantine]

    abusePolicyOverride booleannullable

    If true, this abuse policy overrides the recipient abuse policy.

    spamHeaderName stringnullable

    The spam header name to use if the abuse policy is set to 'flag'.

    Possible values: non-empty

    spamHeaderValue stringnullable

    The spam header value to use if the abuse policy is set to 'flag'.

    Possible values: non-empty

    admins string[]

    A list of email addresses that are the domain admins for the domain.

    downstreamAddresses

    object[]

    The locations of mail servers to which messages will be delivered after filtering.

  • Array [

    • priority integerrequired

    The priority of the dowsntream address. Only addresses with the highest priority (the lowest numerical value) are selected.

    weight integerrequired

    Downstream addresses are selected in proportion to their weights. For example, if there are two downstream addresses, A with weight 40, and B with weight 10, then A is selected 80% of the time and B is selected 20% of the time.

    port integerrequired

    TCP port on which the downstream mail server is listening.

    target stringrequired

    The canonical hostname of the host providing the service, ending in a dot.

    Possible values: <= 255 characters

  • ]

    • aliases string[]

    A list of aliases for the domain. Mail is accepted for these domains and routed to the downstreamAddresses defined for the domain.

  • ]

    • total int32required

    The total number of domains that are accessible with the given API key that match the list of domains in the 'domains' parameter. If there is no 'domains' parameter, this field is the total number of domains that are accessible with with this API key. A domain is accessible with a given API key if it is associated with that API key, or if it is not associated with any API key.

Loading...