IP Allowlist

The IP Allowlist API lets you view and manage allowlisted IP addresses to which api key and SMTP credential usage is restricted.

List Mailgun account IP allowlist entries

get/v2/ip_whitelist

List Mailgun account IP allowlist entries

SecuritybasicAuth

Responses

200

A 200 response

Response Schema: application/json

required

Array of objects

Allowlisted IP address entries on the account

Array

ip_address required	string Allowlisted IP address
description required	string Description of the allowlisted IP address

403

A 403 response

Request samples

Response samples

200
403

application/json

{"addresses": [{"description": "OnPrem Server",
"ip_address": "10.11.11.111"
}
]
}

Update individual Mailgun account IP allowlist entry's description

put/v2/ip_whitelist

Update individual Mailgun account IP allowlist entry's description

SecuritybasicAuth

Request

Request Body schema: multipart/form-data
required

address required	string Address to be updated in the allowlist
description	string Description of the address to be updated in the allowlist, defaults to empty string

Responses

200

A 200 response

Response Schema: application/json

required

Array of objects

Allowlisted IP address entries on the account

Array

ip_address required	string Allowlisted IP address
description required	string Description of the allowlisted IP address

400

A 400 response

Request samples

Response samples

200
400

application/json

{"addresses": [{"description": "OnPrem Server 1",
"ip_address": "10.11.11.111"
}
]
}

Add Mailgun account IP allowlist entry

post/v2/ip_whitelist

Add Mailgun account IP allowlist entry

SecuritybasicAuth

Request

Request Body schema: multipart/form-data
required

address required	string Address to be added to the allowlist
description	string Description of the address to be added to the allowlist, defaults to empty string

Responses

200

A 200 response

Response Schema: application/json

required

Array of objects

Allowlisted IP address entries on the account

Array

ip_address required	string Allowlisted IP address
description required	string Description of the allowlisted IP address

400

A 400 response

Request samples

Response samples

200
400

application/json

{"addresses": [{"description": "OnPrem Server",
"ip_address": "10.11.11.111"
}
]
}

Delete Mailgun account IP allowlist entry

delete/v2/ip_whitelist

Delete Mailgun account IP allowlist entry

SecuritybasicAuth

Request

query Parameters

address

required

string

Address to be deleted from allowlist

Responses

200

A 200 response

Response Schema: application/json

required

Array of objects

Allowlisted IP address entries on the account

Array

ip_address required	string Allowlisted IP address
description required	string Description of the allowlisted IP address

400

A 400 response

Request samples

Response samples

200
400

application/json

{"addresses": [ ]
}

IP Allowlist

List Mailgun account IP allowlist entries

Response Schema: application/json

Update individual Mailgun account IP allowlist entry's description

Request Body schema: multipart/form-datarequired

Response Schema: application/json

Add Mailgun account IP allowlist entry

Request Body schema: multipart/form-datarequired

Response Schema: application/json

Delete Mailgun account IP allowlist entry

query Parameters

Response Schema: application/json

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required