IP Address Warmup

Retrieves the list of in-flight IP address warmup statuses.

get/v3/ip_warmups

Retrieves a list of in-flight IP warmup statuses for dedicated IP addresses owned by the account. The response includes pagination URLs for navigating through the results.

SecuritybasicAuth
Request
query Parameters
page
string

The page to retrieve. If not specified, the first page is returned.

limit
string

The number of results to return per page. Defaults to 10 if not specified.

header Parameters
X-Mailgun-Account-Id
required
string

Account ID

Responses
200

A 200 response

Response Schema: application/json
message
required
string

Response message

Request samples
Response samples
application/json
{
  • "items": [
    • {
      },
    • {
      }
    ],
  • "paging": {
    • "first": "first",
    • "next": "next"
    }
}

Retrieves the status of an in-flight IP warmup

get/v3/ip_warmups/{addr}

Retrieves the status of an in-flight IP warmup, which must be a dedicated IP owned by the account.

SecuritybasicAuth
Request
path Parameters
addr
required
string

The IP address to retrieve the warmup status for.

header Parameters
X-Mailgun-Account-Id
required
string

Account ID

Responses
200

A 200 response

Response Schema: application/json
message
required
string

Response message

Request samples
Response samples
application/json
{
  • "details": {
    • "sent_within_stage": "20%",
    • "throttle": 78,
    • "start_volume": 10000,
    • "stage": 2,
    • "stage_limit": 4000,
    • "hourly_limit": 100,
    • "stage_started_at": "2025-01-01T00:00:00Z",
    • "hour_started_at": "2025-01-01T00:00:00Z",
    • "plan_started_at": "2025-01-01T00:00:00Z",
    • "plan_last_updated_at": "2025-01-01T00:00:00Z",
    • "total_stages": 15,
    • "stage_history": [
      ]
    }
}

Creates a warmup plan for an IP Address

post/v3/ip_warmups/{addr}

Creates a new warmup plan for an IP address. The IP must be dedicated and owned by the account.

SecuritybasicAuth
Request
path Parameters
addr
required
string

The IP address to create the warmup plan for.

header Parameters
X-Mailgun-Account-Id
required
string

Account ID

Responses
200

A 200 response

Response Schema: application/json
message
required
string

Response message

Request samples
Response samples
application/json
{
  • "message": "success"
}

Cancels the warmup plan for an IP address

delete/v3/ip_warmups/{addr}

Cancels the warmup plan for an IP address. The IP must be dedicated and owned by the account.

SecuritybasicAuth
Request
path Parameters
addr
required
string

The IP address to cancel the warmup plan for.

header Parameters
X-Mailgun-Account-Id
required
string

Account ID

Responses
200

A 200 response

Response Schema: application/json
message
required
string

Response message

Request samples
Response samples
application/json
{
  • "message": "success"
}