API Documentation

API Documentation

Security Tools
About Usage Results Sample Output
About

API version: 1.0

The Security Tools allow you to check security details for your website such as SSL certificates.

Usage

Send a GET request to /api/security/certificate to get the TLS/SSL certificate for a site.

Example - Browser:

https://networkcalc.com/api/security/certificate/example.com

Example - cURL:

curl https://networkcalc.com/api/security/certificate/example.com

Example - PowerShell:

(Invoke-RestMethod https://networkcalc.com/api/security/certificate/example.com).certificate

Specify the host port to use:

?port=8080

Results
Name Type Description
status string The status of the request.
'OK' is a good request.
'NO_HOST_SPECIFIED' means you did not specify a hostname.
'INVALID_PORT' means you specified a port that is out of range. Should be between 0 and 65535.
'TIMEOUT' means either the network connection timed out or no certificate exists on the host's port.
certificate JSON object The certificate.
certificate.issued_to string The host to which the certified was issued.
certificate.valid_from string The date on which the certificate is valid. Date format is ISO 8601.
certificate.valid_from string The date on which the certificate expires. Date format is ISO 8601.
certificate.alternate_names array of string An array of Subject Alternative Names (SANs) for the certificate.
certificate.serial_number string The certificate's serial number, a unique identifier.
certificate.fingerprint string The certificate's fingerprint, a computed hash of the entire certificate.
certificate.raw string The certificate in its raw format.
Sample Output
GET
https://networkcalc.com/api/security/certificate/networkcalc.com 

    {
        "status": "OK",
        "meta": {
            "protocol": "https:",
            "hostname": "networkcalc.com",
            "port": null
        },
        "certificate": {
            "issued_to": "networkcalc.com",
            "issued_by": "Let's Encrypt Authority X3",
            "valid_from": "2020-08-18T22:20:53.000Z",
            "valid_to": "2020-11-16T22:20:53.000Z",
            "alternate_names": [
                "DNS:networkcalc.com",
                "DNS:www.networkcalc.com"
            ],
            "serial_number": "047EA13CF1EFF5C7A3BA5AA68F0A3CCB8DFF",
            "fingerprint": "B1:B5:90:DB:B1:F8:B3:63:1D:90:45:F2:DF:53:58:F0:02:FA:2E:99",
            "raw": "-----BEGIN CERTIFICATE-----\nMIIFazCCBFOgAwIBAgISBH6hPPHv9cejulqmjwo8y43/MA0GCSqGSIb3DQEBCwUA\nMEoxCzAJBgNVBAYTAlVTMRYwFAYDVQQKEw1MZXQncyBFbmNyeXB0MSMwIQYDVQQD\nExpMZXQncyBFbmNyeXB0IEF1dGhvcml0eSBYMzAeFw0yMDA4MTgyMjIwNTNaFw0y\nMDExMTYyMjIwNTNaMBoxGDAWBgNVBAMTD25ldHdvcmtjYWxjLmNvbTCCASIwDQYJ\nKoZIhvcNAQEBBQADggEPADCCAQoCggEBAOwZIfXDWo1CWWlIDQzKRYYEmCbDTWeZ\nNNUzlxLBMkZRTEvr8DN0smiATM6AY2TYfpvsiGrdqgmr9x2+55YopOlfbK9xTix6\n8eNaMjThvXvJCML2nyHiK9y1cNM3j2c9JLVHtEc3F3VRpyB7rKfdhUqa57VxQgCF\nqfUlxeLbfraLA+T5D36UWQjBPHBN+O0f//Lp/gurWWbqRcVd8uZkKHtqU4tbVxWH\nR0277swI1qK41M2aZjlNhrjhYfxlGoRCKuOs8LhsDlDFpoXPjQrVNUIcQVxBi9MK\n4OvuY6KVoS8BR4mOIPG2TOQhmJekRM6EkMXTbCVe0beTFRNz8y1PaucCAwEAAaOC\nAnkwggJ1MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYB\nBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQUrHla5cpG847nGAR0MZ+4q1l6\n3eQwHwYDVR0jBBgwFoAUqEpqYwR93brm0Tm3pkVl7/Oo7KEwbwYIKwYBBQUHAQEE\nYzBhMC4GCCsGAQUFBzABhiJodHRwOi8vb2NzcC5pbnQteDMubGV0c2VuY3J5cHQu\nb3JnMC8GCCsGAQUFBzAChiNodHRwOi8vY2VydC5pbnQteDMubGV0c2VuY3J5cHQu\nb3JnLzAvBgNVHREEKDAmgg9uZXR3b3JrY2FsYy5jb22CE3d3dy5uZXR3b3JrY2Fs\nYy5jb20wTAYDVR0gBEUwQzAIBgZngQwBAgEwNwYLKwYBBAGC3xMBAQEwKDAmBggr\nBgEFBQcCARYaaHR0cDovL2Nwcy5sZXRzZW5jcnlwdC5vcmcwggEEBgorBgEEAdZ5\nAgQCBIH1BIHyAPAAdgDwlaRZ8gDRgkAQLS+TiI6tS/4dR+OZ4dA0prCoqo6ycwAA\nAXQD4B7JAAAEAwBHMEUCIQDoeEsx9xLUQCkHCitLIieMpKH1k26itttDzY6KmE2D\n9wIgUmuUOY1Z42IYYDbJHA8aWwNv/9B+CpYZAXWR+4bSs2oAdgCyHgXMi6LNiiBO\nh2b5K7mKJSBna9r6cOeySVMt74uQXgAAAXQD4B63AAAEAwBHMEUCIEEbm++wRYwc\nkMbtnDEpPBlfje+mPEkmVumfwy8oOFqlAiEAvZhMPYck0AQ2sovMzFbOgd8WtqTN\nEoWAwiQ5XNW7x6wwDQYJKoZIhvcNAQELBQADggEBAGEK1KylQ0lhXeAhPIj+bulT\nXBnGGrhD7NSFcmsvRIxBp9JKkbPbhkYQYqldJFWNspSZF5M0AXghBX3I7A5nAteQ\nKQBC6Unpkyl1SelgkNcHGpxEDEFzoKtGp6khyAkGrnmqKgmsM7CRJN5C7eeUTen2\nzhX5CVYv2FoL7zIxHXTj2c/LEVb8EU+VDmx1+lWYaucCqujLCOvYSzhSYFd/9Vg/\nT8RQzOZeR54k8d6oVapk6XwO27ghBlmOw0agLbEyi+q4fgqjYfHDphonClDagMdg\n3NXPhnp04vri0vEi8PTM0lWL+HZ7rrQsRbkbK9LXwFreXFV+cgvFnCs0z/8SMTQ=\n\n-----END CERTIFICATE-----"
        }
    }