Skip to content

Remove domain from dynamic IP pools

Request

The behavior of this endpoint depends on the value of the replacement_ip and replacement_pool_id parameters. One of these parameters (but not both) must be provided. If replacement_ip is provided, the IP(s) will be assigned to the domain. replacement_ip can include one of the following:

  • valid IP(s): this IP address or addresses will be added to the domain
  • string shared: if the account is eligible for shared IPs, a suitable shared IP will be chosen and added to the domain The 'replacement_ip' parameter cannot include any IPs that are already assigned to a Dedicated IP Pool or a Dynamic IP Pool. If replacement_pool_id is provided, the Dedicated IP Pool will be assigned to the domain.
Security
basicAuth
Path
namestringrequired

Domain name

Query
replacement_ipstringrequired

A valid IP address or 'shared'. This field can be specified multiple times if all provided IPs are dedicated. Cannot be provided if providing 'replacement_pool_id' param

replacement_pool_idstringrequired

A valid dedicated IP pool ID to assign to the domain. Cannot be provided if providing 'replacement_ip' param

curl -i -X DELETE \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v3/domains/{name}/dynamic_pools?replacement_ip=string&replacement_pool_id=string'

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

Response
{ "message": "success" }