Help Portal

Assets ​

The IPMonitor Asset Management API provides a suite of RESTful endpoints for efficiently managing and monitoring IP addresses and domains. This documentation offers a detailed guide on using these endpoints, complete with full request and response examples.

Retrieve IP Address List ​

GET /api/v1/ip-list

This endpoint fetches a comprehensive list of all monitored IP addresses.

bash
curl -X 'GET' \
  'https://ipmonitor.mydomain.com/api/v1/ip-list' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer your_api_token_here'
curl -X 'GET' \
  'https://ipmonitor.mydomain.com/api/v1/ip-list' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer your_api_token_here'
json
[
  {
    "ip": "64.137.54.64",
    "hosts": [
      "srv1.karbonmta.com"
    ],
    "senderscore": -1,
    "senderscore_prev": -1,
    "senderscore_change": {
      "last_check": 0
    },
    "blacklisted": 1,
    "blacklisted_change": {
      "last_check": 1
    },
    "snds_blocked": null,
    "snds_blocked_change": {
      "last_check": null
    },
    "snds_reputation": null,
    "snds_reputation_change": {
      "last_check": null
    }
  }
]
[
  {
    "ip": "64.137.54.64",
    "hosts": [
      "srv1.karbonmta.com"
    ],
    "senderscore": -1,
    "senderscore_prev": -1,
    "senderscore_change": {
      "last_check": 0
    },
    "blacklisted": 1,
    "blacklisted_change": {
      "last_check": 1
    },
    "snds_blocked": null,
    "snds_blocked_change": {
      "last_check": null
    },
    "snds_reputation": null,
    "snds_reputation_change": {
      "last_check": null
    }
  }
]

Response Status Codes:

  • 200 Success
  • 401 Unauthorized
  • 403 Forbidden
  • 503 Service Unavailable

Retrieve Domain List ​

GET /api/v1/domain-list

This endpoint provides a list of all domains currently under surveillance.

bash
curl -X 'GET' \
  'https://ipmonitor.mydomain.com/api/v1/domain-list' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer your_api_token_here'
curl -X 'GET' \
  'https://ipmonitor.mydomain.com/api/v1/domain-list' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer your_api_token_here'
json
[
  {
    "domain": "m.mydomain.com",
    "ips": null,
    "senderscore": null,
    "senderscore_prev": null,
    "senderscore_change": {
      "last_check": 0
    },
    "blacklisted": 3,
    "blacklisted_change": {
      "last_check": 0
    },
    "snds_blocked": null,
    "snds_blocked_change": {
      "last_check": null
    },
    "snds_reputation": null,
    "snds_reputation_change": {
      "last_check": null
    }
  }
]
[
  {
    "domain": "m.mydomain.com",
    "ips": null,
    "senderscore": null,
    "senderscore_prev": null,
    "senderscore_change": {
      "last_check": 0
    },
    "blacklisted": 3,
    "blacklisted_change": {
      "last_check": 0
    },
    "snds_blocked": null,
    "snds_blocked_change": {
      "last_check": null
    },
    "snds_reputation": null,
    "snds_reputation_change": {
      "last_check": null
    }
  }
]

Response Status Codes:

  • 200 Success
  • 401 Unauthorized
  • 403 Forbidden
  • 503 Service Unavailable

Get Asset Report ​

GET /api/v1/asset/{asset}

Access detailed reports for a specific asset, identified by IP or domain.

bash
curl -X 'GET' \
  'https://ipmonitor.mydomain.com/api/v1/asset/64.137.54.64' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer your_api_token_here'
curl -X 'GET' \
  'https://ipmonitor.mydomain.com/api/v1/asset/64.137.54.64' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer your_api_token_here'
json
{
   "value":"64.137.54.64",
   "tags":[
      "tag1",
      "tag2",
      "tag3"
   ],
   "hostname":[
      "srv1.karbonmta.com"
   ],
   "senderscore":99,
   "senderscore_prev":88,
   "senderscore_change":{
      "last_check":0
   },
   "senderscore_history":[
      {
         "value":"-1",
         "date":"21st Oct 2023 10:15am"
      },
      {
         "value":"-1",
         "date":"10th Sep 2023 07:49pm"
      }
   ],
   "blacklisted":1,
   "blacklisted_prev":0,
   "blacklisted_change":{
      "last_check":1
   },
   "blacklisted_history":[
      {
         "value":1,
         "date":"21st Oct 2023 10:15am"
      },
      {
         "value":0,
         "date":"12th Sep 2023 07:57am"
      }
   ],
   "blacklist_history":[
      {
         "date":"21st Oct 2023 10:15am",
         "status":"Listed",
         "blacklist":"dnsbl-3.uceprotect.net"
      },
      {
         "date":"3rd Sep 2023 02:56pm",
         "status":"Listed",
         "blacklist":"dnsbl.openresolvers.org"
      }
   ],
   "snds_blocked":null,
   "snds_blocked_change":{
      "last_check":null
   },
   "snds_reputation":null,
   "snds_reputation_change":{
      "last_check":null
   },
   "snds_data":[
      
   ],
   "hostname_history":[
      {
         "date":"21st Oct 2023 10:15am",
         "hostname":[
            "srv1.karbonmta.com"
         ]
      }
   ],
   "administrative_notes":[
      {
         "date":"26th Aug 2023 08:06pm",
         "note":"Customer A IP address"
      }
   ]
}
{
   "value":"64.137.54.64",
   "tags":[
      "tag1",
      "tag2",
      "tag3"
   ],
   "hostname":[
      "srv1.karbonmta.com"
   ],
   "senderscore":99,
   "senderscore_prev":88,
   "senderscore_change":{
      "last_check":0
   },
   "senderscore_history":[
      {
         "value":"-1",
         "date":"21st Oct 2023 10:15am"
      },
      {
         "value":"-1",
         "date":"10th Sep 2023 07:49pm"
      }
   ],
   "blacklisted":1,
   "blacklisted_prev":0,
   "blacklisted_change":{
      "last_check":1
   },
   "blacklisted_history":[
      {
         "value":1,
         "date":"21st Oct 2023 10:15am"
      },
      {
         "value":0,
         "date":"12th Sep 2023 07:57am"
      }
   ],
   "blacklist_history":[
      {
         "date":"21st Oct 2023 10:15am",
         "status":"Listed",
         "blacklist":"dnsbl-3.uceprotect.net"
      },
      {
         "date":"3rd Sep 2023 02:56pm",
         "status":"Listed",
         "blacklist":"dnsbl.openresolvers.org"
      }
   ],
   "snds_blocked":null,
   "snds_blocked_change":{
      "last_check":null
   },
   "snds_reputation":null,
   "snds_reputation_change":{
      "last_check":null
   },
   "snds_data":[
      
   ],
   "hostname_history":[
      {
         "date":"21st Oct 2023 10:15am",
         "hostname":[
            "srv1.karbonmta.com"
         ]
      }
   ],
   "administrative_notes":[
      {
         "date":"26th Aug 2023 08:06pm",
         "note":"Customer A IP address"
      }
   ]
}

Response Status Codes:

  • 200 Success
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not Found
  • 503 Service Unavailable