Skip to content
Mailgun Optimize
/
Mailgun Optimize API Reference
/
Domains

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
inboxready.json
inboxready.yaml
Languages
Servers
US Mailgun

https://api.mailgun.net/

EU Mailgun

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

Domains

Operations

Returns Domains on Mailgun Optimize services

Request

Will return details on an Mailgun Optimize Domain. If no Domain is provided, then a list of all Mailgun Optimize Domains on an account will be returned.

Security
basicAuth
Query
limitinteger

Limit

domainstring

Domain name

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/inboxready/domains?limit=0&domain=string'

Responses

A 200 response

Bodyapplication/json
itemsArray of objects(Inbox_Ready_github.com-mailgun-inboxready-model-Domain)required
items[].​created_atinteger(int64)required
items[].​namestringrequired
items[].​verifiedobject(Inbox_Ready_github.com-mailgun-inboxready-model-Verified)required
items[].​verified.​verified_atinteger(int64)required
items[].​verified.​statusstringrequired
items[].​servicesobjectrequired
items[].​services.​property name*booleanadditional property
items[].​txt_recordstringrequired
pagingobject(Inbox_Ready_github.com-mailgun-scaffold-httpapi-paging-PagingResponse)
Response
application/json
{
  "items": [
    { … }
  ],
  "paging": {
    "previous": "https://....",
    "first": "https://....",
    "next": "https://....",
    "last": "https://...."
  }
}

Add a single domain to an account

Request

Security
basicAuth
Query
domainstringrequired

Domain name

curl -i -X POST \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/inboxready/domains?domain=string'

Responses

A 200 response

Bodyapplication/json
messagestringrequired
domainobject(Inbox_Ready_github.com-mailgun-inboxready-model-Domain)required
domain.​created_atinteger(int64)required
domain.​namestringrequired
domain.​verifiedobject(Inbox_Ready_github.com-mailgun-inboxready-model-Verified)required
domain.​verified.​verified_atinteger(int64)required
domain.​verified.​statusstringrequired
domain.​servicesobjectrequired
domain.​services.​property name*booleanadditional property
domain.​txt_recordstringrequired
Response
application/json
{
  "message": "The domain has been added",
  "domain": {
    "name": "domain.tld",
    "verified": { … },
    "services": { … },
    "txt_record": "IR-hashed-txt-record-key"
  }
}

Deletes a single domain from an account

Request

Security
basicAuth
Query
domainstringrequired

Domain name

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/inboxready/domains?domain=string'

Responses

A 200 response

Bodyapplication/json
messagestringrequired
Response
application/json
{
  "message": "domain.tld has been removed from Mailgun Optimize"
}

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

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