Skip to content

Mailgun API (0.0.0)

Mailgun API defined by OpenAPI Specification (OAS) 3.1.0

Download OpenAPI description
openapi-final.json
openapi-final.yaml
Languages
Servers
Mock server

https://documentation.mailgun.com/_mock/docs/mailgun/api-reference/openapi-final/

US Mailgun

https://api.mailgun.net/

EU Mailgun

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

Messages

Send email two ways via our REST API:

  1. Send emails using MIME format using a MIME building library
  2. Submit the individual parts (Text, html, attachments, etc.)

Reminder: You can also send email via SMTP with Mailgun. Please reference the user manual.

Operations

Domains

Domains API manages domains, domain keys and DNS verification.

Operations

Domain Keys

An authentication standard used to prevent email spoofing.

Operations

Domain Tracking

Mailgun offers tracking for clicks, unsubscribes, and opens, with optional HTTPS protocol support on tracking URLs. To enable HTTPS, Mailgun uses Let’s Encrypt with HTTP-01 challenges through your existing tracking CNAME record to issue a TLS certificate. This setup also includes support for HTTP Strict Transport Security (HSTS) for enhanced security.

Operations

DKIM Security

Automatic Sender Security DKIM Key APIs. To enable this feature please see 'Update a domain' API docs.

Operations

Webhooks

Webhooks API manages domain's webhooks. You can create, access and delete webhooks programmatically.

Operations

Metrics

Mailgun collects many different events and generates event metrics which are available in your Control Panel. This data is also available via our analytics metrics API endpoint.

Operations

Logs

Mailgun keeps track of every inbound and outbound message event and stores this log data. This data can be queried and filtered to provide insights into the health of your email infrastructure.

Operations

Tags New

Mailgun allows you to tag your email with unique identifiers. Tags are visible via our analytics tags API endpoint.

Operations

Stats

Mailgun collects many different events and generates event statistics which are available in your Control Panel. This data is also available via our stats API endpoint.

WARNING: This API is deprecated in favor of our Metrics API.

Operations

Tags

Mailgun lets you tag each outgoing message with a custom value. When you access stats on your messages, they will be aggregated by these tags.

WARNING: This API is deprecated in favor of our new Tags API.

Operations

Events

Mailgun keeps track of every inbound and outbound message event and stores this data for at least 3 days.

WARNING: This API is deprecated in favor of our Logs API.

Operations

Unsubscribe

Unsubscribe list stores email addresses of recipients who unsubscribed from your mailings by clicking a Mailgun generated unsubscribe link.

Operations

Complaints

Email addresses of recipients who marked your messages as a spam (for ESPs that support FBL).

Operations

Bounces

Bounces - Bounce list stores events of delivery failures due to permanent recipient mailbox errors such as non-existent mailbox. Soft bounces (for example, mailbox is full) and other failures (for example, ESP rejects an email because it thinks it is spam) are not added to the list.

Operations

Allowlist

The allowlist API provides the ability to allowlist specific addresses from being added to bounce list. You can allowlist by domain name (i.e example.com) or by specific address (i.e. alice@example.com). Mailgun doesn’t add an address to bounce list if the address is allowlisted. This API is very useful if you test against your private services and don’t want to constantly clean up bounce lists

Operations

Routes

Define a list of routes to handle incoming emails. When a message matches a route expression, Mailgun can forward it on to your application via HTTP or another email address, or store the message temporarily (3 days) for subsequent retrieval.

Operations

Mailing Lists

Programatically create mailing lists.

Operations

Templates

This API allows you to store predefined templates and use them to send messages using the Sending API.

Operations

IP Pools

IP Pools allow you to group your dedicated IPs into customized "pools" to help manage your sending reputation for different mail sending streams.

Operations

Dynamic IP Pools

Dynamic IP Pools allow you to group your dedicated IPs into customized "pools" based on sender reputation. Health checks are performed on domains and assigned to the appropriate Dynamic Pool.

Operations

Enrolls a domain in the Dynamic IP Pools feature

Request

Domains enrolled in the Dynamic IP pools feature will be assigned an IP pool based on reputation. The feature must be enabled and configured before enrolling domains.

Security
basicAuth
Path
namestringrequired

Domain name. Converted to X-Mailgun-Domain-Id header by the middleware.

Query
replacement_ipstringrequired

A valid IP address or 'shared'

Headers
X-Mailgun-Account-Idstringrequired

Account ID

X-Mailgun-Requestorstringrequired

Email address of the user making the request.

X-Mailgun-Requestor-Clientstringrequired

Identifier of the client application making the request.

curl -i -X POST \
  -u <username>:<password> \
  'https://documentation.mailgun.com/_mock/docs/mailgun/api-reference/openapi-final/v3/domains/{name}/dynamic_pools?replacement_ip=string' \
  -H 'X-Mailgun-Account-Id: string' \
  -H 'X-Mailgun-Requestor: string' \
  -H 'X-Mailgun-Requestor-Client: string'

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

Response
application/json
{
  "message": "success"
}

Remove an a domain from the Dynamic IP pools feature

Request

The behavior of the 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 not be provided if providing 'replacement_pool_id' param

replacement_pool_idstringrequired

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

Headers
X-Mailgun-Account-Idstringrequired

Account ID

X-Mailgun-Requestorstringrequired

Email address of the user making the request.

X-Mailgun-Requestor-Clientstringrequired

Identifier of the client application making the request.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://documentation.mailgun.com/_mock/docs/mailgun/api-reference/openapi-final/v3/domains/{name}/dynamic_pools?replacement_ip=string&replacement_pool_id=string' \
  -H 'X-Mailgun-Account-Id: string' \
  -H 'X-Mailgun-Requestor: string' \
  -H 'X-Mailgun-Requestor-Client: string'

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

Response
application/json
{
  "message": "success"
}

Retrieve domains that are assignable to Dynamic IP Pools.

Request

Security
basicAuth
Query
subaccount_idstring

If provided, queries domains belonging to the subaccount. Must be a valid account ID

domainstring

Regex search term to query a domain by name

Headers
X-Mailgun-Account-Idstringrequired

Account ID

X-Mailgun-Requestorstringrequired

Email address of the user making the request.

X-Mailgun-Requestor-Clientstringrequired

Identifier of the client application making the request.

curl -i -X GET \
  -u <username>:<password> \
  'https://documentation.mailgun.com/_mock/docs/mailgun/api-reference/openapi-final/v3/domains/dynamic_pools/assignable?subaccount_id=string&domain=string' \
  -H 'X-Mailgun-Account-Id: string' \
  -H 'X-Mailgun-Requestor: string' \
  -H 'X-Mailgun-Requestor-Client: string'

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

Response
application/json
{
  "items": [
    { … }
  ]
}

IPs

The IP API endpoint allows you to access information regarding the IPs allocated to your Mailgun account that are used for outbound sending.

Operations

IP Address Warmup

Operations

Subaccounts

Mailgun supports the creation, modification, and deletion of subaccounts. A subaccount is a child account of a parent account. The parent account can have multiple subaccounts. The subaccounts are created and managed by the parent account.

Operations

Custom Message Limit

The custom message limit imposes a hard limit on how many messages your account can send during a calendar month.

Operations

Account Management

Perform account-level CRUD operations.

Operations

Keys

The Keys API lets you view and manage api keys.

Operations

Credentials

The Credentials API lets you view and manage SMTP credentials.

Operations

IP Allowlist

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

Operations

Users

Mailgun API supports viewing user entities.

Operations