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

total_countinteger, (int64)required

total number of account IPs

Response

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