CMS Web Services - v4.0.6410.15363 [cms-a]

<back to all web services

Blacklist

Returns a number 0-x indicating if the submitted IP address (v4 only) is blacklisted by zero, one or more DNSBL services. Also returned are the names of the DNSBL services returning a positive result (if any). This service uses a number of popular DNS spam blacklist'ing services (currently: Barracuda, Spamcop, and Spamhaus)

The following routes are available for this service:
POST,GET/blacklist/query
Blacklist Parameters:
NameParameterData TypeRequiredDescription
IPbodystringYesA single version 4 IP address (dotted notation in string format)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
BlacklistResponse Parameters:
NameParameterData TypeRequiredDescription
BlacklistCountformintNo
BlacklistSourcesformstringNo
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/Blacklist HTTP/1.1 
Host: cms.winlink.org 
Content-Type: application/json
Content-Length: length

{"IP":"String","Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"BlacklistCount":0,"BlacklistSources":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}