API Guide

Add Monitor Item

Add Monitor Item allows customers to add an IP, domain name, IP, or CIDR entry to an existing blacklist profile. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: POST

Endpoint URL:

https://api.250ok.com/api/1.0/blacklistinformant/additem

Sample Output:

{
    "status": "success"
}                    

Parameters

Parameter	Description	Acceptable Values	Required
profile_id	The unique identifier of the monitor summary. NOTE: Profile IDs can be retrieved by executing the Profile Summary API call.	Integer	Y
itemtype	The type of monitored items to add.	ip, cidr, ip_range, domain_name	Y
item	The value of the item type, requires valid IP, domain, CIDR, or IP. Acceptable values include: X.X.X.X (ip) X.X.X.X-Y (ip_range) X.X.X.X/Y (cidr) domain.tld (domain_name)	String	Y
description	The description field for the item.	String	N

Error Responses

Description	Code	Cause
Invalid profile ID.	404	The unique identifier of the profile is empty or invalid.
Invalid item type.	404	The 'itemtype' parameter is empty or invalid.
Invalid item value.	404	The 'item' parameter is empty or invalid.
Error	404	Validation failure: returns full error string
No results found.	403	Forbidden / We couldn't find any results matching your criteria.