Overview
TLS Check connects to the provided domain and port and runs a TLS handshake for each protocol version to determine which are supported. It identifies the highest negotiable version (like TLS 1.2/1.3), flags whether deprecated TLS 1.0/1.1 remain exposed, and returns a composite risk score summarizing the server's protocol security.
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl "https://api.apiverve.com/v1/tlscheck?domain=amazon.com&port=443" \
-H "x-api-key: your_api_key_here"const res = await fetch('https://api.apiverve.com/v1/tlscheck?domain=amazon.com&port=443', {
headers: { 'x-api-key': 'your_api_key_here' },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.get(
"https://api.apiverve.com/v1/tlscheck?domain=amazon.com&port=443",
headers={"x-api-key": "your_api_key_here"},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/tlscheck?domain=amazon.com&port=443", nil)
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent in the query string. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
domainRequired | string | The domain to check the TLS/SSL configuration for domain |
portOptional | integer | The port to connect to (usually 443 for HTTPS) default 443 · range 1–65535 |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": {
"domain": "amazon.com",
"tlsVersions": {
"TLSv1": false,
"TLSv1.1": false,
"TLSv1.2": true,
"TLSv1.3": true
},
"highestVersion": "TLSv1.3",
"hasDeprecatedTLS": false,
"isSecure": true,
"riskScore": 0,
"riskLevel": "low"
}
}Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
domain | string | "amazon.com" | Domain name that was checked for TLS configuration |
tlsVersions | object | {...} | |
TLSv1 | boolean | false | Whether TLS 1.0 protocol is supported by server |
1 | boolean | false | Whether TLS 1.1 protocol is supported by server |
2 | boolean | true | Whether TLS 1.2 protocol is supported by server |
3 | boolean | true | Whether TLS 1.3 protocol is supported by server |
highestVersion | string | "TLSv1.3" | The highest TLS version the server supports (e.g. TLSv1.3), or null if none were negotiable |
hasDeprecatedTLSPremium | boolean | false | Whether the server still supports deprecated TLS 1.0 or 1.1, which are insecure and disallowed by PCI-DSS |
isSecurePremium | boolean | true | Whether the server supports a modern TLS version (1.2/1.3) and does not expose any deprecated version |
riskScorePremium | number | 0 | Composite 0-100 risk score based on missing modern TLS and exposure of deprecated protocols (higher is riskier) |
riskLevelPremium | string | "low" | Risk band derived from the score: low, medium or high |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Other ways to use TLS Checker
Set up TLS Checker on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Related
More in Networking: