Provided "as is" without any warranty of any kind

Provided "as is" without any warranty of any kind

ImmuniWeb Discovery

For continuous monitoring purposes, we suggest you exploring our award-winning ImmuniWeb® Discovery offering tailored for continuous monitoring with flexible 24/7 notifications.

Commercial API

ImmuniWeb provides a commercial access to the SSL Security Test API with extended limits to the number daily tests. Please get in touch with us to get a personalized quote. Prices start at 500 USD per month.

Non-profit, research and academic institutions may request commercial API for free. Please send your API usage requirements to for additional information.

Free API

ImmuniWeb provides you with a free API to test your SSL/TLS servers. To assure high speed of service and availability for everyone, the free API allows 50 requests in total per 24 hours, from one IP address.



In order to prevent abuse, a protection mechanism has been set up to remove the ability to test IPs that are not related to the tested domain name. As a consequence if a domain name is resolved into several IPs, a second request will be mandatory, specifying one of the IPs replied by the server along with the token issued (examples are below). However, if the tested domain name can be resolved into only one IP address, it will be immediately tested.

In addition, there are different tiers of user, with each providing a different level of usage with the API.

License notice: The API is provided for free both for private and commercial purposes. When using the free API, a clearly-visible credit to ImmuniWeb® Community when displaying results is mandatory. Failure to properly do so may trigger a ban and legal consequences.

API Documentation and How-To

Full API Documentation

API Specifications

Field Name Value Protocol HTTPS Request Type POST URL https://www.immuniweb.com/ssl/api/v1/check/[ustamp].html - where "ustamp" is an arbitrary UNIX time-stamp (must be an integer). Such construction is done to prevent caching on client side.

POST Data Specification

Field Name Value api_key secret token which you submit alongside with the request domain:port must be a valid domain name, or IP address, followed by a port number. If port is not supplied, 443 is used by default. show_test_results "false" means that test results will be hidden, "true" means that test results will be displayed in statistics. choosen_ip IP address of tested server (if tested domain resolves to multiple addresses). recheck "false" will use results from cache if the server has been tested within the past 24 hours, "true" will perform a new test without looking at the cache. verbosity 1 means output will be detailed, 0 means output will be short. token value of the token sent by the server if the tested domain is resolved into several IP addresses.

Example of Transaction Using CURL

$ curl -XPOST -d 'domain=twitter.com:443&choosen_ip=any&show_test_results=true&recheck=false&verbosity=1' 'https://www.immuniweb.com/ssl/api/v1/check/1451425590.html'



{"debug":true,"job_id":"2a9e1f1bc92dc0c7a4bde930dff488771eea6d36988208d34163c5496227b8dc","status":"test_started","status_id":1,"message":"Test has started"}



$ curl -XPOST -d 'job_id=2a9e1f1bc92dc0c7a4bde930dff488771eea6d36988208d34163c5496227b8dc' 'https://www.immuniweb.com/ssl/api/v1/get_result/1451425590.html'



{"job_id":"2a9e1f1bc92dc0c7a4bde930dff488771eea6d36988208d34163c5496227b8dc","status":"in_progress","status_id":2,"eta":2,"message":"Your test is in progress"}





$ curl -XPOST -d 'domain=twitter.com:443&choosen_ip=any&show_test_results=true&recheck=false&verbosity=1' 'https://www.immuniweb.com/ssl/api/v1/check/1451425590.html'



{"test_id":"c84936eef26eeb8aaef5ffc43f38ddb91adfd90ac27fb416bd0b21fe2edb1004","status":"test_cached","status_id":3,"message":"Test is cached"}



$ curl -XPOST -d 'id=c84936eef26eeb8aaef5ffc43f38ddb91adfd90ac27fb416bd0b21fe2edb1004' 'https://www.immuniweb.com/ssl/api/v1/get_result/1451425590.html'





$ curl -XPOST -d 'domain=twitter.com:443&show_test_results=true&recheck=false&verbosity=1' 'https://www.immuniweb.com/ssl/api/v1/check/1451425590.html'



{"multiple_ips":["199.16.156.6","199.16.156.102","199.16.156.70","199.16.156.230"],"token":"68j3OCZLEomtjASxKoObjZXzX7p2M7L0"}



$ curl -XPOST -d 'domain=twitter.com:443&show_test_results=true&recheck=false&choosen_ip=199.16.156.230&verbosity=1&token=68j3OCZLEomtjASxKoObjZXzX7p2M7L0' 'https://www.immuniweb.com/ssl/api/v1/check/1451425590.html'





$ curl -XPOST -d 'domain=0.0.0.0&show_test_results=true&recheck=false&verbosity=1' 'https://www.immuniweb.com/ssl/api/v1/check/1451425590.html'



{"error":"The domain name cannot be resolved","error_id":7}





Example of Server Response