Skip to main content
POST
/
tlsscan
Perform TLS scan for a given domain
curl --request POST \
  --url https://api.geekflare.com/tlsscan \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://example.com"
}
'
{
  "timestamp": 1778737930991,
  "apiStatus": "success",
  "apiCode": 200,
  "meta": {
    "url": "example.com",
    "test": {
      "id": "40zt4but04y07ccn4pov5fiolzrxbxdg"
    }
  },
  "data": {
    "protocols": {
      "tls10": false,
      "tls11": false,
      "tls12": true,
      "tls13": true
    },
    "certificate": {
      "commonName": "sni.cloudflaressl.com",
      "subjectAltName": "DNS:*.example.com, DNS:sni.cloudflaressl.com, DNS:example.com",
      "issuer": {
        "country": "US",
        "organization": "Cloudflare, Inc.",
        "commonName": "Cloudflare Inc ECC CA-3"
      },
      "expiry": "Jun  6 23:59:59 2023 GMT"
    }
  }
}

Authorizations

​
x-api-key
string
header
required

API Key required for all endpoints

Body

application/json
​
url
string
required

Target URL

Example:

"https://example.com"

Response

Successfully retrieved TLS scan information

​
timestamp
number
required

Timestamp of the request in milliseconds

Example:

1778737930991

​
apiStatus
enum<string>
required

API status message

Available options:
success,
failure
Example:

"success"

​
apiCode
number
required

API status code

Example:

200

​
meta
object
required

Metadata about the TLS scan request

Example:
{
  "url": "example.com",
  "test": { "id": "40zt4but04y07ccn4pov5fiolzrxbxdg" }
}
​
data
object
required

TLS scan result data

Example:
{
  "protocols": {
    "tls10": false,
    "tls11": false,
    "tls12": true,
    "tls13": true
  },
  "certificate": {
    "commonName": "sni.cloudflaressl.com",
    "subjectAltName": "DNS:*.example.com, DNS:sni.cloudflaressl.com, DNS:example.com",
    "issuer": {
      "country": "US",
      "organization": "Cloudflare, Inc.",
      "commonName": "Cloudflare Inc ECC CA-3"
    },
    "expiry": "Jun  6 23:59:59 2023 GMT"
  }
}