Skip to content

Alerts (0.0.1)

Our alerting solution is centered around two concepts: events and channels. The occurrence of an event can be configured to trigger an alert. A channel describes the delivery method for an alert. Every configured alert consists of an event type / channel pair. This level of granularity allows alerting to be configured to your exact preference.

Download OpenAPI description
Languages
Servers
US Mailgun

https://api.mailgun.net/

EU Mailgun

https://api.eu.mailgun.net/

Domains

Operations

DMARC Reports

DMARC reporting provides valuable insights into your infrastructure, helping you identify potential issues like senders, misconfigured email servers, or phishing attempts.

Operations

Inbox Placement

Inbox Placement testing allows you to see the likely deliverability of your email campaigns.

Operations

Update Seed List

Request

Security
basicAuth
Path
addressstringrequired
Query
namestring
provider_filterstring

Array of provider domains. Omitting means no changes.

regenboolean

Regenerate the mailing_list.

sending_domainsstring

Deprecated.

curl -i -X PUT \
  -u <username>:<password> \
  'https://api.mailgun.net/v4/inbox/seedlists/{address}?name=string&provider_filter=string&regen=true&sending_domains=string'

Responses

A 200 response

Bodyapplication/json
kidstringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
last_result_atstring(date-time)required
target_emailstringrequired
sending_domainsArray of stringsrequired
has_resultsbooleanrequired
namestringrequired
seed_filterstringrequired
provider_filterArray of stringsrequired

[] means all providers; null means that only seed_filter is used

mailing_liststringrequired
previous_mailing_liststringrequired

List before last regen

tagsobjectrequired
tags.​property name*stringadditional property
delivery_statsobject
is_auto_generatedbooleanrequired
versioninteger(int32)required
regen_neededbooleanrequired

Shows that mailing_list has to many unavailable seeds. Only for v2 Seed List.

regen_atstring(date-time)required
Response
application/json
{ "created_at": "0001-01-01 00:00:00 +0000 UTC", "updated_at": "0001-01-01 00:00:00 +0000 UTC", "last_result_at": "0001-01-01 00:00:00 +0000 UTC", "regen_at": "0001-01-01 00:00:00 +0000 UTC" }

Delete a Seed List

Request

Security
basicAuth
Path
addressstringrequired
curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.mailgun.net/v4/inbox/seedlists/{address}'

Responses

A 200 response

Response
No content

List Results

Request

Get the details for all placement test results.

Security
basicAuth
Query
senderstring
subjectstring
providerstring
target_emailstring
time_afterstring
time_beforestring
cursorstring
sortstring
offsetinteger
ascendingboolean
limitinteger
curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v4/inbox/results?sender=string&subject=string&provider=string&target_email=string&time_after=string&time_before=string&cursor=string&sort=string&offset=0&ascending=true&limit=0'

Responses

A 200 response

Bodyapplication/json
property name*objectadditional property
Response
application/json
{ "items": [ {} ], "total": 1 }

Bounce Classification

Operations

Spam Traps Monitoring

Our spam trap monitoring service surfaces how much of your email is being sent to known spam traps.

Operations

Email Health Score

Operations

IP Blocklist Monitoring

Operations

Domain Blocklist Monitoring

Blocklist Monitoring enables you to keep an eye on your reputation. Monitor your domains against our curated list of blocklist providers to make sure you aren't being blocked.

Operations

Google Postmaster Tools

This API provides access to Google Postmaster data.

Operations

Microsoft SNDS

This API provides access to Microsoft SNDS data.

Operations

Alerts

Operations