Set downstream address

PUT 
/domains/:domain/downstream-address

Sets the list of downstream addreses for the domain. This action deletes any existing downstream address for the domain before creating new ones. If the 'records' parameter is an empty array, all downstream address records will be deleted.

Request

Path Parameters

domain hostnamerequired

The domain name.

application/json

Body

required

records

object[]

Possible values: <= 10

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

]

Responses

201

The list of downstream addresses was set to be the list submitted with the request.

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

This 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 Server Error

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

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

Loading...