List account IPs - detailed view

Messages

Send email two ways via our REST API:

Send emails using MIME format using a MIME building library
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

Account Webhooks

Webhooks API to manage account-specific webhooks. You can create, retrieve, update, and delete webhooks programmatically. Account-level webhooks are configured independently for US and EU regions. When triggered, webhook URLs are deduplicated by event type, across account and domain levels to prevent redundant webhook sends.

Operations

Domain Webhooks

Webhooks API to manage domain-specific webhooks. You can create, retrieve, update, and delete webhooks programmatically. When triggered, webhook URLs are deduplicated by event type, across account and domain levels to prevent redundant webhook sends.

Operations

Metrics

The Mailgun Metrics API provides programmatic access to detailed analytics data about your email sending activity. This API allows you to query, filter, and analyze email performance metrics to gain insights into deliverability, engagement, and overall sending health.

Operations

Logs

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

Operations

Bounce Classification

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

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

Send Alerts

Mailgun allows you to get instant notifications on the sending metrics that matter most, configured specifically for your unique business needs and assets. Route these alerts to the channels your team relies on. Stay on top of sending performance without the need to manually monitor.

Operations

Alerts

Operations

Limits

Mailgun allows you to set limits on your subaccounts to help you manage usage and costs. You can create, update, retrieve, and delete limits for various pre-send features such as email previews and email validations.

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

Forwards

This API allows you to manage forwarding of incoming emails.

Operations

Mailing Lists

Programatically create mailing lists.

Operations

Account Templates

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

Operations

Domain Templates

This API allows you to store predefined templates at the domain level 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. Domains enrolled in Dynamic IP Pools will be assigned to a pool based on the result of periodic health checks.

Operations

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

Add a new dedicated IP to the account

Request

A new IP can be assigned only if billing limits allow that.

Security

basicAuth

curl -i -X POST \
  -u <username>:<password> \
  https://api.mailgun.net/v3/ips/request/new

Responses

A 200 response

Bodyapplication/json

string(string)

Response

application/json

{
  "message": "success"
}

List account IPs - detailed view

Request

List IPs belonging to the account and subaccounts. For IPs linked to subaccounts, there will be an additional record returned per subaccount The detailed IP view feature must be enabled for the account.

Security

basicAuth

Query

limitinteger[ 10 .. 100 ]

Maximum records to return

Default 10

skipinteger

The amount of returned records to skip

Default 0

pool_idstring

Filter IPs linked to a pool. Value can be a specific pool ID, 'any' or 'none'

domain_idstring

Filter IPs linked to a domain. Value can be a specific domain ID, 'any' or 'none'

subaccount_idstring

Filter IPs linked to a subaccount. Value can be a specific subaccount ID, 'any' or 'none'

ipstring

Search for IPs containing this text (supports partial matching)

sort_bystring

Name of the field to sort results by

sort_orderstring

Sort results 'descending' or 'ascending'

Default "ascending"

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v3/ips/details/all?limit=10&skip=0&pool_id=string&domain_id=string&subaccount_id=string&ip=string&sort_by=string&sort_order=ascending'

Responses

A 200 response

Bodyapplication/json

itemsArray of objects(github.com-mailgun-tower-api-account-list_ips-AccountIPDoc)required

list of IPs belonging to the account and subaccounts

items[].addressstringrequired

the IP address

items[].parent_account_idstringrequired

the id of the parent account

items[].account_idstringrequired

the id of the account

items[].pool_idsArray of stringsrequired

list of pool ids

items[].dedicatedbooleanrequired

whether the IP is dedicated

items[].created_atstring(date-time)

the time the IP was created

items[].pool_last_modified_atstring(date-time)required

the last time the pool was modified

items[].domains_last_modified_atstring(date-time)required

the last time the domains were modified

total_countinteger(int64)required

total number of account IPs

Response

application/json

{
  "items": [
    { … },
    { … },
    { … }
  ],
  "total_count": 3
}

Update subaccount IP assignments

Request

Description

Links and/or unlinks dedicated IPs to/from one or more subaccounts in a single operation. IPs linked to subaccounts can be linked to subaccount domains and placed in subaccount IP pools. The account must have the centralized IP assignment feature enabled.

Either subaccount_id (one or more) or all_subaccounts=true must be specified, but not both. When all_subaccounts=true or over 100 subaccounts are specified, the operation is applied to every subaccount asynchronously and the response will contain 'queued' instead of 'success'.

Rules for linking an IP: The IP must be a dedicated IP belonging to the parent account. The IP must not be assigned to a Dynamic IP Pool on the parent account.

Rules for unlinking an IP: The IP must not be assigned to any IP pools on the subaccount. The IP must not be assigned to any domains on the subaccount.

Request Schema

Request parameters are encoded as form data.

Name	Description	Required	Type
subaccount_id	Id of a subaccount to update (may be specified multiple times). Required unless all_subaccounts is true.	false	string
all_subaccounts	When true, applies the operation to all subaccounts of the parent account asynchronously. Cannot be combined with subaccount_id.	false	string
link_ip	Dedicated IP address to link to the subaccount (may be specified multiple times)	false	string
unlink_ip	Dedicated IP address to unlink from the subaccount (may be specified multiple times)	false	string

Security

basicAuth

curl -i -X PATCH \
  -u <username>:<password> \
  https://api.mailgun.net/v3/ips/subaccounts

Responses

A 200 response

Bodyapplication/json

messagestringrequired

Response message

Response

application/json

{
  "message": "success"
}

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

Mailgun API (3.0.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

Messages

Domains

Domain Keys

Domain Tracking

DKIM Security

Account Webhooks

Domain Webhooks

Metrics

Logs

Bounce Classification

Tags New

Stats

Tags

Events

Send Alerts

Alerts

Limits

Unsubscribe

Complaints

Bounces

Allowlist

Routes

Forwards

Mailing Lists

Account Templates

Domain Templates

IP Pools

Dynamic IP Pools

IPs

Add a new dedicated IP to the account

Request

Responses

Was this helpful?

List account IPs - detailed view

Request

Responses

Was this helpful?

Update subaccount IP assignments

Request

Description

Request Schema

Responses

Was this helpful?

IP Address Warmup

Subaccounts

Custom Message Limit

Account Management

Keys

Credentials

IP Allowlist

Users

Mailgun API (3.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code