Fetch downstream addresses

GET 
/domains/:domain/downstream-address

Retrieve stored downstream addresses for the domain.

Request

Path Parameters

domain hostnamerequired

The domain name.

Query Parameters

limit integer

Possible values: >= 1

The number of results to return, defaults to 10.

offset integer

The offset into the results to return, defaults to 0.

Responses

200

Downstream addresses were fetched successfully.

application/json

Schema

Schema

records

object[]

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

]

Example (from schema)

{
  "records": [
    {
      "priority": 0,
      "weight": 0,
      "port": 0,
      "target": "string"
    }
  ]
}

400

Bad Request, returned in the case that an error occurs while converting an A-label domain to a U-label domain name.

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

403

Returned in the case that the domain is associated with an api key that is different than the one in the request, the domain is associated with a different customer, or the domain in the request is an alias domain.

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

404

The domain does not exist.

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

500

Internal Error

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

Loading...