v1

latestOpenAPI 3.1.02026-07-24700259.3 KB

IP AUTH

View IP Auth

Returns a list of all IP Auth entries that are managed by this account, or details of a specific IP Auth, when you include the [ip_address] in your request. If no entries are available, this will return an empty list.

post/ip_auth/view

Request body

ip_addressstring

If passed, a valid ip address of an existing IP Auth entry that you wish to view

subaccount_idstring

If you wish to make this API call on behalf of a subaccount then include its unique ID here

Response

List of IP Auth entries

request_idstring required

Example response

{
  "request_id": "aa253464-0bd0-467a-b24b-6159dcd7be60",
  "data": {
    "results": [
      {
        "comments": "Comment explaining how amazing this IP Auth entry is",
        "ip_addres": "127.0.0.1",
        "email_password": "H#8dkK2djs",
        "sending_allowed": true,
        "custom_ratelimit": true,
        "custom_ratelimit_value": 100,
        "custom_ratelimit_period": "1 day",
        "default_ratelimit_period": "unlimited",
        "ippool": 1234,
        "feedback_enabled": true,
        "feedback_domain": "default",
        "archive_enabled": true,
        "open_tracking_enabled": true,
        "bounce_notifications": "from"
      }
    ]
  }
}