ssllabs-api-docs-v4.md

SSL Labs API v4 Documentation v2.x.x (work in progress)#

Last update: 17 October 2023
Author: Nauman Shah [email protected]

This document explains the SSL Labs Assessment APIs, which can be used to test SSL servers available on the public Internet.

Protocol Overview

The protocol is based on HTTP and JSON. All API calls should use GET except for register API, which must use POST. Specify the parameters in the query string with HTTP header of the registered email, as explained in the following paragraphs. The response body contains the results in a JSON payload. For example, the client requests an assessment from the servers. and receives an existing report if. Otherwise, the server will start a new assessment and the client should periodically check to see if the job is complete.

Terms and Conditions

SSL Labs APIs are provided free of charge, subject to our terms and conditions: https://www.ssllabs.com/about/terms.html. The spirit of the license is that the APIs are made available so that system operators can test their own infrastructure. Please read the actual terms and conditions, which are more involved and cover things such as integrating with open source projects, and so on. For example, it's important (for reasons of privacy, compliance, etc) for end users to understand that assessments are carried out by Qualys's servers, not locally.

Commercial use is generally not allowed, except with an explicit permission from Qualys. That said, we're usually happy to support good causes, even uses by commercial organizations that help improve the security of their customers. If you're a CA, CDN, hosting company, domain name registrar, we're happy for you to use our APIs (but you still have to get in touch with us before you begin).

API Calls

This section documents the available API calls. The main API entry point is "https://api.ssllabs.com/api/v4/". If you want to check the API availability from a browser, invoke "https://api.ssllabs.com/api/v4/info". There is also an additional API entry point that can be used to test features that have not yet been deployed to production: "https://api.dev.ssllabs.com/api/v4/". You should expect that this second entry point is not consistently available. Further it offers only reduced assessment limits in comparison with the production version.

Register for Scan API initiation and result fetching

SSLLabs has been available directly for all its users directly via UI and API to be consumed freely. It will remain the same with slight change with introduction to this new registration API. Now you need to register yourself with first name, last name, organization's name and organization's email.

API Call: register

This call will return Registration response.

Parameters:

Parameter	Mandatory/Optional	Data Type	Description
firstName	Mandatory	String	Provide first name
lastName	Mandatory	String	Provide last name
email	Mandatory	String	Provide organization email Note: We do not allow the use of email services such as Gmail, Yahoo, or Hotmail
organization	Mandatory	String	Provide name of the organization

Examples:

• curl --location 'https://<SSLLABS_HOSTNAME>/api/v4/register' --header 'Content-Type: application/json' --data '{ "firstName":"John", "lastName":"Doe", "email":"[email protected]", "organization":"Some Organization"}'

Check SSL Labs availability

This API request should be used to check the availability of the SSL Labs servers, retrieve the engine and criteria version, and initialize the maximum number of concurrent assessments. On success, it returns Info object.

API Call: info

Parameters:

• None.

Invoke assessment and check progress

This API request is used to initiate an assessment, or to retrieve the status of an assessment in progress or in the cache. It will return a single Host object on success. The Endpoint object embedded in the Host object will provide partial endpoint results. Please note that assessments of individual endpoints can fail even when the overall assessment is successful (e.g., one server might be down). At this time, you can determine the success of an endpoint assessment by checking the statusMessage field; it should contain "Ready".

API Call: analyze

Parameters:

Parameter	Mandatory/Optional	Data Type	Description
host	Mandatory	String	Provide hostname
publish	Optional	String	Set to on if assessment results needs to be published on the public results boards. Default: off
startNew	Optional	String	If on setting is enabled, a new assessment is started, even if there is a cached assessment in progress. However, if an assessment is in progress, its status is returned instead of starting a new assessment. Note: This parameter should only be used once to start a new assessment; any additional use may cause an assessment loop.
fromCache	Optional	String	Delivers cached assessment reports if available. This parameter is intended for API consumers who do not wish to wait for assessment results and cannot be used simultaneously with the startNew parameter. Default: off
maxAge	Optional	String	Maximum report age in hours if retrieving from cache (fromCache parameter).
all	Optional	String	Displays summaries of individual endpoints. Default: on When the parameter is set to on, full information will be returned. When the parameter is set to done, full information will be returned only if the assessment is complete (status is READY or ERROR).
ignoreMismatch	Optional	String	Ignores the mismatch if server certificate doesn't match the assessment hostname and proceeds with assessments if set to on. Default: off Note: This parameter is ignored if a cached report is returned.

Header:

Parameter	Mandatory/Optional	Data Type	Description
email	Mandatory	String	Provide the email address registered through the registration API

Examples:

• curl --location 'https://<SSLLABS_HOSTNAME>/api/v4/analyze?host=www.ssllabs.com' --header 'email: [email protected]'
• curl --location 'https://<SSLLABS_HOSTNAME>/api/v4/analyze?host=www.ssllabs.com&publish=on' --header 'email: [email protected]'

Retrieve detailed endpoint information

This API request is used to retrieve detailed endpoint information. It will return a single Endpoint object on success. The object will contain complete assessment information. This API call does not initiate new assessments, even when a cached report is not found.

API Call: getEndpointData

Parameters:

Parameter	Mandatory/Optional	Data Type	Description
host	Mandatory	String	Provide hostname
s	Mandatory	String	Provide endpoint IP address
fromCache	Optional	String	Delivers cached assessment reports if available. This parameter is intended for API consumers who do not wish to wait for assessment results and cannot be used simultaneously with the startNew parameter. Default: off

Header:

Parameter	Mandatory/Optional	Data Type	Description
email	Mandatory	String	Provide the email address registered through the registration API

Example:

• curl --location 'https://<SSLLABS_HOSTNAME>/api/v4/analyze?host=www.ssllabs.com&s=173.203.82.166' --header 'email: [email protected]'

Retrieve known status codes

This API request returns one StatusCodes instance.

API Call: getStatusCodes

Parameters:

• None.

Retrieve root certificates

This API request returns the latest root certificates(Mozilla, Apple MacOS, Android, Java and Windows) used for trust validation.

API Call: getRootCertsRaw

Parameters:

Parameter	Mandatory/Optional	Data Type	Description
trustStore	Mandatory	String	Provide the value. 1-Mozilla 2-Apple MacOS 3-Android 4-Java 5-Windows Default: 1-Mozilla

Example:

• https://api.ssllabs.com/api/v3/getRootCertsRaw?trustStore=1 Or https://api.ssllabs.com/api/v3/getRootCertsRaw
• https://api.ssllabs.com/api/v3/getRootCertsRaw?trustStore=2
• https://api.ssllabs.com/api/v3/getRootCertsRaw?trustStore=3
• https://api.ssllabs.com/api/v3/getRootCertsRaw?trustStore=4
• https://api.ssllabs.com/api/v3/getRootCertsRaw?trustStore=5

Protocol Usage

Follow these steps to obtain the latest test results for a specific host:

1. Invoke analyze with the startNew parameter to on. Set all to done.
2. The assessment is now in progress. Call analyze periodically (without the startNew parameter!) until the assessment is finished. You can tell by observing the Host.status field for either READY or ERROR values.
3. When there are multiple servers behind one hostname, they will be tested one at a time.
4. During the assessment, interim responses will contain only endpoint status, but not full information.
5. At the end of the assessment, the response will contain all available information; no further API calls will need to be made for that host.

When you want to receive cached information in a browser add-on, follow these steps:

1. Invoke analyze with fromCache set to on and all set to done.
2. Set maxAge to control the maximum age of the cached report. If you don't set this parameter, your IP address is not be forwarded to the tested server.
3. If the information you requested is available in the cache, it is returned immediately.
4. Otherwise, a new assessment will start.
5. You can continue to call analyze periodically until the assessment is complete.

Error Reporting

When an API call is incorrectly invoked, it will cause an error response to be sent back. The response will include an array of error messages. For example:

{"errors":[{"field":"host","message":"qp.mandatory"}]}

The field value references the API parameter name that has an incorrect value. The message value will tell you what the issue is. It is also possible to receive errors without the field parameter set; such messages will usually refer to the request as a whole.

Error Response Status Codes

The following status codes are used:

Code	Description	Action
400	Invocation error	Invalid parameters
441	unauthorized error. not register please refer Register API	Invalid parameters
429	client request rate too high or too many new assessments too fast	Track how many concurrent requests are allowed
500	internal errorr	Retry the request
503	the service is not available (e.g., down for maintenance)	Wait for some time (approximately 15 minutes) before retrying
529	the service is overloaded	Wait for some time (approximately 15 minutes) before retrying

A well-written client should never get a 429 response. If you do get one, it means that you're either submitting new assessments at a rate that is too fast, or that you're not correctly tracking how many concurrent requests you're allowed to have. If you get a 503 or 529 status code, you should sleep for several minutes (e.g., 15 and 30 minutes, respectively) then try again. It's best to randomize the delay, especially if you're writing a client tool -- you don't want everyone to retry exactly at the same time. If you get 500, it means that there's a severe problem with the SSL Labs application itself. A sensible approach would be to mark that one assessment as flawed, but to continue on. However, if you continue to receive 500 responses, it's best to give up.

Access Rate and Rate Limiting

Please note the following:

• Server assessments usually take at least 60 seconds. (They are intentionally slow, to avoid harming servers.) Thus, there is no need to poll for the results very often. In fact, polling too often slows down the service for everyone. It's best to use variable polling: 5 seconds until an assessment gets under way (status changes to IN_PROGRESS), then 10 seconds until it completes.
• Keep down the number of concurrent assessments to a minimum. If you're not in a hurry, test only one hostname at a time.

We may limit your usage of the API, by enforcing a limit on concurrent assessments, and the overall number of assessments performed in a time period. If that happens, we will respond with 429 (Too Many Requests) to API calls that wish to initiate new assessments. Your ability to follow previously initiated assessments, or retrieve assessment results from the cache, will not be impacted. If you receive a 429 response, reduce the number of concurrent assessments and check that you're not submitting new assessments at a rate higher than allowed.

If the server is overloaded (a condition that is not a result of the client's behaviour), the 529 status code will be used instead. This is not a situation we wish to be in. If you encounter it, take a break and come back later.

All successful API calls contain response headers X-Max-Assessments and X-Current-Assessments. They can be used to calculate how many new assessments can be submitted. It is recommended that clients update their internal state after each complete response.

Protocol Evolution

The API is versioned. New versions of the API will be introduced whenever incompatible changes need to be made to the protocol. When a new version becomes available, existing applications can continue to use the previous version for as long as it is supported.

To reduce version number inflation, new fields may be added to the results without a change in protocol version number.

Response Objects

The remainder of the document explains the structure of the returned objects. The following conventions are used:

Parameter	Description
field	a simple field
object{}	an object
array[]	an array

Register

Parameter	Description
message	Registration message response
status	Either success or failure

Info

Parameter	Description
engineVersion	SSL Labs software version as a string (e.g., "2.2.0")
criteriaVersion	Rating criteria version as a string (e.g., "2009f")
maxAssessments	The maximum number of concurrent assessments the client is allowed to initiate.
currentAssessments	The number of ongoing assessments submitted by this client.
newAssessmentCoolOff	The cool-off period after each new assessment, in milliseconds; you're not allowed to submit a new assessment before the cool-off expires, otherwise you'll get a 429.
messages	A list of messages (strings). Messages can be public (sent to everyone) and private (sent only to the invoking client). Private messages are prefixed with "[Private]"

Host

Parameter	Description
host	Assessment host, which can be a hostname or an IP address
port	Assessment port (e.g., 443)
protocol	Protocol (e.g., HTTP)
isPublic	true if this assessment is publicly available (listed on the SSL Labs assessment boards)
status	Assessment status; possible values: DNS, ERROR, IN_PROGRESS, and READY.
statusMessage	Status message in English. When status is ERROR, this field will contain an error message.
startTime	Assessment starting time, in milliseconds since 1970
testTime	Assessment completion time, in milliseconds since 1970
engineVersion	Assessment engine version (e.g., "2.2.0")
criteriaVersion	Grading criteria version (e.g., "2009l")
cacheExpiryTime	When will the assessment results expire from the cache (typically set only for assessment with errors; otherwise the results stay in the cache for as long as there's sufficient room)
certHostnames[]	The list of certificate hostnames collected from the certificates seen during assessment. The hostnames may not be valid. This field is available only if the server certificate doesn't match the requested hostname. In that case, this field saves you some time as you don't have to inspect the certificates yourself to find out what valid hostnames might be.
endpoints[]	list of Endpoint objects
certs[]	a list of Cert object, representing the chain certificates in the order in which they were retrieved from the server.

Endpoint

Parameter	Description
ipAddress	Endpoint IP address, in IPv4 or IPv6 format.
serverName	Server name retrieved via reverse DNS
statusMessage	Assessment status message; this field will contain "Ready" if the endpoint assessment was successful.
statusDetails	Code of the operation currently in progress
statusDetailsMessage	Description of the operation currently in progress
grade	Possible values: A+, A-, A-F, T (no trust) and M (certificate name mismatch)
gradeTrustIgnored	Grade (as above), if trust issues are ignored
futureGrade	Next grade because of upcoming grading criteria changes, Null if there is no impact on current grade.
hasWarnings	If this endpoint has warnings that might affect the score (e.g., get A- instead of A).
isExceptional	This flag will be raised when an exceptional configuration is encountered. The SSL Labs test will give such sites an A+.
progress	Endpoint IP address, in IPv4 or IPv6 format.
eta	Estimated time, in seconds, until the completion of the assessment
delegation	Indicates domain name delegation with and without the www prefix bit 0 (1) - set for non-prefixed access bit 1 (2) - set for prefixed access
details	This field contains an EndpointDetails object. It's not present by default, but can be enabled by using the "all" parameter to the analyze API call.

EndpointDetails

Parameter	Description
hostStartTime	Endpoint assessment starting time, in milliseconds since 1970. This field is useful when test results are retrieved in several HTTP invocations. Then, you should check that the hostStartTime value matches the startTime value of the host.
certChains[]	Server Certificate chains
protocols[]	Supported protocols
suites[]	Supported cipher suites per protocol
noSniSuites	cipher suites observed only with client that does not support Server Name Indication (SNI).
namedGroups	Instance of NamedGroups object.
serverSignature	Contents of the HTTP Server response header when known. This field could be absent for one of two reasons: 1) the HTTP request failed (check httpStatusCode) or 2) there was no Server response header returned.
prefixDelegation	true if this endpoint is reachable via a hostname with the www prefix
nonPrefixDelegation	(moved here from the summary) - true if this endpoint is reachable via a hostname without the www prefix
vulnBeast	true if the endpoint is vulnerable to the BEAST attack
renegSupport	This is an integer value that describes the endpoint support for renegotiation: bit 0 (1) - set if insecure client-initiated renegotiation is supported bit 1 (2) - set if secure renegotiation is supported bit 2 (4) - set if secure client-initiated renegotiation is supported bit 3 (8) - set if the server requires secure renegotiation support
sessionResumption	This is an integer value that describes endpoint support for session resumption. The possible values are: 0 - session resumption is not enabled and we're seeing empty session IDs 1 - endpoint returns session IDs, but sessions are not resumed 2 - session resumption is enabled
compressionMethods	Integer value that describes supported compression methods bit 0 (1) is set for DEFLATE
supportsNpn	true if the server supports NPN
npnProtocols	Space separated list of supported NPN protocols
supportsAlpn	true if the server supports ALPN
alpnProtocols	Space separated list of supported ALPN protocols
sessionTickets	Indicates support for Session Tickets bit 0 (1) - set if session tickets are supported bit 1 (2) - set if the implementation is faulty [not implemented] bit 2 (4) - set if the server is intolerant to the extension
ocspStapling	true if OCSP stapling is deployed on the server
staplingRevocationStatus	Same as Cert.revocationStatus, but for the stapled OCSP response.
staplingRevocationErrorMessage	Description of the problem with the stapled OCSP response, if any.
sniRequired	If SNI support is required to access the web site.
httpStatusCode	Status code of the final HTTP response seen. When submitting HTTP requests, redirections are followed, but only if they lead to the same hostname. If this field is not available, that means the HTTP request failed.
httpForwarding	Available on a server that responded with a redirection to some other hostname.
supportsRc4	true if the server supports at least one RC4 suite.
rc4WithModern	true if RC4 is used with modern clients.
forwardSecrecy	Indicates support for Forward Secrecy bit 0 (1) - set if at least one browser from our simulations negotiated a Forward Secrecy suite. bit 1 (2) - set based on Simulator results if FS is achieved with modern clients. For example, the server supports ECDHE suites, but not DHE. bit 2 (4) - set if all simulated clients achieve FS. In other words, this requires an ECDHE + DHE combination to be supported.
supportsAead	true if the server supports at least one AEAD suite.
supportsCBC	true if the server supports at least one CBC suite.
protocolIntolerance	Indicates protocol version intolerance issues: bit 0 (1) - TLS 1.0 bit 1 (2) - TLS 1.1 bit 2 (4) - TLS 1.2 bit 3 (8) - TLS 1.3 bit 4 (16) - TLS 1.152 bit 5 (32) - TLS 2.152
miscIntolerance	Indicates various other types of intolerance: bit 0 (1) - extension intolerance bit 1 (2) - long handshake intolerance bit 2 (4) - long handshake intolerance workaround success
sims	instance of SimDetails.
heartbleed	true if the server is vulnerable to the Heartbleed attack.
heartbeat	true if the server supports the Heartbeat extension.
openSslCcs	Results of the CVE-2014-0224 test: -1 - test failed 0 - unknown 1 - not vulnerable 2 - possibly vulnerable, but not exploitable 3 - vulnerable and exploitable
openSSLLuckyMinus20	Results of the CVE-2016-2107 test: -1 - test failed 0 - unknown 1 - not vulnerable 2 - vulnerable and insecure
ticketbleed	Results of the ticketbleed CVE-2016-9244 test: -1 - test failed 0 - unknown 1 - not vulnerable 2 - vulnerable and insecure 3 - not vulnerable but a similar bug detected (additional details)
bleichenbacher	Results of the Return Of Bleichenbacher's Oracle Threat (ROBOT) test: -1 - test failed 0 - unknown 1 - not vulnerable 2 - vulnerable (weak oracle) 3 - vulnerable (strong oracle) 4 - inconsistent results
zombiePoodle	Results of the Zombie POODLE test: -1 - test failed 0 - unknown 1 - not vulnerable 2 - vulnerable 3 - vulnerable and exploitable
goldenDoodle	Results of the GOLDENDOODLE test: -1 - test failed 0 - unknown 1 - not vulnerable 4 - vulnerable 5 - vulnerable and exploitable
zeroLengthPaddingOracle	Results of the 0-Length Padding Oracle (CVE-2019-1559) test: -1 - test failed 0 - unknown 1 - not vulnerable 6 - vulnerable 7 - vulnerable and exploitable
sleepingPoodle	Results of the Sleeping POODLE test: -1 - test failed 0 - unknown 1 - not vulnerable 10 - vulnerable 11 - vulnerable and exploitable
poodle	true if the endpoint is vulnerable to POODLE; false otherwise
poodleTls	Results of the POODLE TLS test: -3 - timeout -2 - TLS not supported -1 - test failed 0 - unknown 1 - not vulnerable 2 - vulnerable
fallbackScsv	true if the server supports TLS_FALLBACK_SCSV, false if it doesn't. This field will not be available if the server's support for TLS_FALLBACK_SCSV can't be tested because it supports only one protocol version (e.g., only TLS 1.2).
freak	true if the server is vulnerable to the FREAK attack, meaning it supports 512-bit key exchange.
hasSct	information about the availability of certificate transparency information (embedded SCTs): bit 0 (1) - SCT in certificate bit 1 (2) - SCT in the stapled OCSP response bit 2 (4) - SCT in the TLS extension (ServerHello)
dhPrimes[]	list of hex-encoded DH primes used by the server. Not present if the server doesn't support the DH key exchange.
dhUsesKnownPrimes	Whether the server uses known DH primes. Not present if the server doesn't support the DH key exchange. Possible values: 0 - no 1 - yes, but they're not weak 2 - yes and they're weak
dhYsReuse	true if the DH ephemeral server value is reused. Not present if the server doesn't support the DH key exchange.
ecdhParameterReuse	true if the server reuses its ECDHE values
logjam	true if the server uses DH parameters weaker than 1024 bits.
chaCha20Preference	true if the server takes into account client preferences when deciding if to use ChaCha20 suites. Will be deprecated in new version.
hstsPolicy{}	Server's HSTS policy.
hstsPreloads[]	Information about preloaded HSTS policies.
hpkpPolicy{}	Server's HPKP policy.
hpkpRoPolicy{}	Server's HPKP-RO policy.
staticPkpPolicy{}	Server's SPKP policy.
httpTransactions[]	An array of HttpTransaction objects.
drownHosts[]	List of DROWN hosts.
drownErrors	true if error occurred in the DROWN test.
drownVulnerable	true if server vulnerable to the DROWN attack.
implementsTLS13MandatoryCS	true if server supports mandatory TLS 1.3 cipher suite (TLS_AES_128_GCM_SHA256), null if TLS 1.3 not supported.
zeroRTTEnabled	Results of the 0-RTT test. This test will only be performed if TLS 1.3 is enabled: -2 - test failed -1 - test not performed (default) 0 - 0-RTT is not enabled 1 - 0-RTT is enabled

CertificateChain

Parameter	Description
id[]	Certificate chain ID
certIds[]	List of IDs of each certificate, representing the chain certificates in the order in which they were retrieved from the server
trustPaths[]	trust path object
issues	A number of flags that describe the chain and the problems it has: bit 0 (1) - unused bit 1 (2) - incomplete chain (set only when we were able to build a chain by adding missing intermediate certificates from external sources) bit 2 (4) - chain contains unrelated or duplicate certificates (i.e., certificates that are not part of the same chain) bit 3 (8) - the certificates form a chain (trusted or not), but the order is incorrect bit 4 (16) - contains a self-signed root certificate (not set for self-signed leafs) bit 5 (32) - the certificates form a chain (if we added external certificates, bit 1 will be set), but we could not validate it. If the leaf was trusted, that means that we built a different chain we trusted.
noSni	true for certificate obtained only with No Server Name Indication (SNI).

trustPath

Parameter	Description
certIds[]	List of certificate ID from leaf to root.
trust[]	trust object. This object shows info about the trusted certificate by using Mozilla trust store.
isPinned	true if a key is pinned, else false
matchedPins	Number of matched pins with HPKP policy
unmatchedPins	Number of unmatched pins with HPKP policy

trust

Parameter	Description
rootStore	This field shows the Trust store being used (eg. "Mozilla")
isTrusted	true if trusted against above rootStore
trustErrorMessage	Shows the error message if any, Null otherwise.

Protocol

Parameter	Description
id	Protocol version, e.g. 771 for TLS 1.2 (0x0303)
name	Protocol name SSL/TLS.
version	Protocol version, e.g. 1.2, 1.1 etc
v2SuitesDisabled	Some servers have SSLv2 protocol enabled, but with all SSLv2 cipher suites disabled. In that case, this field is set to true.
q	0 if the protocol is insecure, null otherwise

ProtocolSuites

Parameter	Description
protocol	Protocol version.
list[]	List of Suite objects
preference	true if the server actively selects cipher suites; if null, we were not able to determine if the server has a preference
chaCha20Preference	true if the server takes into account client preferences when deciding if to use ChaCha20 suites. null, we were not able to determine if the server has a chacha preference.

Suite

Parameter	Description
id	suite RFC ID (e.g., 5)
name	suite name (e.g., TLS_RSA_WITH_RC4_128_SHA)
cipherStrength	suite strength (e.g., 128)
kxType	key exchange type (e.g., ECDH)
kxStrength	key exchange strength, in RSA-equivalent bits
dhP	DH params, p component
dhG	DH params, g component
dhYs	DH params, Ys component
namedGroupBits	EC bits
namedGroupId	EC curve ID
namedGroupName	EC curve name
q	flag for suite insecure or weak. Not present if suite is strong or good 0 - insecure 1 - weak

NamedGroups

Parameter	Description
list	an array of NamedGroup objects
preference	true if the server has preferred curves that it uses first

NamedGroup

Parameter	Description
Id	named curve ID
Name	named curve name
bits	named curve strength in EC bits

SimDetails

Parameter	Description
results[]	instances of Simulation.

Simulation

Parameter	Description
client	Instance of SimClient.
errorCode	Zero if handshake was successful, 1 if it was not.
errorMessage	Error message if simulation has failed.
attempts	Always 1 with the current implementation.
certChainId	id of the certificate chain.
protocolId	Negotiated protocol ID.
suiteId	Negotiated suite ID.
suiteName	Negotiated suite Name.
kxType	Negotiated key exchange, for example "ECDH".
kxStrength	Negotiated key exchange strength, in RSA-equivalent bits.
dhBits	Strength of DH params (e.g., 1024)
dhP	DH params, p component
dhG	DH params, g component
dhYs	DH params, Ys component
namedGroupBits	When ECDHE is negotiated, length of EC parameters.
namedGroupId	When ECDHE is negotiated, length of EC parameters.
namedGroupName	When ECDHE is negotiated, EC curve nanme (e.g., "secp256r1").
keyAlg	Connection certificate key algorithsm (e.g., "RSA").
keySize	Connection certificate key size (e.g., 2048).
sigAlg	connection certificate signature algorithm (e.g, "SHA256withRSA").

SimClient

Parameter	Description
id	Unique client ID.
name	Name of the client (e.g., Chrome).
platform	Name of the platform (e.g., XP SP3).
version	Version of the software being simulated (e.g., 49)
isReference	true if the browser is considered representative of modern browsers, false otherwise. This flag does not correlate to client's capabilities, but is used by SSL Labs to determine if a particular configuration is effective. For example, to track Forward Secrecy support, we mark several representative browsers as "modern" and then test to see if they succeed in negotiating a FS suite. Just as an illustration, modern browsers are currently Chrome, Firefox (not ESR versions), IE/Win7, and Safari.

HstsPolicy

Parameter	Description
LONG_MAX_AGE	This constant contains what SSL Labs considers to be sufficiently large max-age value
header	The contents of the HSTS response header, if present
status	HSTS status: unknown - either before the server is checked or when its HTTP response headers are not available absent - header not present present - header present and syntatically correct invalid - header present, but couldn't be parsed disabled - header present and syntatically correct, but HSTS is disabled
error	Error message when error is encountered, null otherwise
maxAge	The max-age value specified in the policy; null if policy is missing or invalid or on parsing error; the maximum value currently supported is 9223372036854775807
includeSubDomains	true if the includeSubDomains directive is set; null otherwise
preload	true if the preload directive is set; null otherwise
directives[][]	List of raw policy directives

HstsPreload

The HstsPreload object contains preload HSTS status of one source for the current hostname. Preload checks are done for the current hostname, not for a domain name. For example, a hostname "www.example.com" tested in SSL Labs would come back as "present" if there is an entry for "example.com" with includeSubDomains enabled or if there is an explicit entry for "www.example.com".

Parameter	Description
source	Source name
hostname	Name of the host
status	Preload status: error unknown - either before the preload status is checked, or if the information is not available for some reason. absent present
error	Error message, when status is "error"
sourceTime	Time, as a Unix timestamp, when the preload database was retrieved

HpkpPolicy

Parameter	Description
header	The contents of the HPKP response header, if present
status	HPKP status: unknown - either before the server is checked or when its HTTP response headers are not available absent - header not present invalid - header present, but couldn't be parsed disabled - header present and syntatically correct, but HPKP is disabled incomplete - header present and syntatically correct, incorrectly used partial - header present and synatatically correct, but not all paths pinned valid - header present, syntatically correct, and correctly used
error	Error message, when the policy is invalid
maxAge	The max-age value from the policy
includeSubDomains	true if the includeSubDomains directive is set; null otherwise
reportUri	The report-uri value from the policy
pins[]	List of all pins used by the policy
matchedPins[]	List of pins that match the current configuration; each list entry contains an object with two fields, hashFunction and value (hex-encoded)
directives[][]	List of raw policy directives (name-value pairs)

staticPkpPolicy

Parameter	Description
status	SPKP status: unknown - either before the server is checked or when its preload list not available absent - static pinning not present invalid - static pinning present, but couldn't be parsed incomplete - static pinning present but doesn't match configuration partial - static pinning present but not all trust paths pinned forbidden - static pinning present, forbidden pinns matched valid - static pinning present, syntatically correct, and correctly used
error	Error message, when the policy is invalid
includeSubDomains	true if the includeSubDomains directive is set else false
reportUri	The report-uri value from the policy
pins[]	List of all pins used by the policy
matchedPins[]	List of pins that match the current configuration; each list entry contains an object with two fields, hashFunction and value (hex-encoded)
forbiddenPins[]	List of all forbidden pins used by policy;
matchedForbiddenPins[]	list of forbidden pins that match the current configuration; each list entry contains an object with two fields, hashFunction and value (hex-encoded)

HttpTransaction

Parameter	Description
requestUrl	Request URL
statusCode	Response status code
requestLine	The entire request line as a single field
requestHeaders[]	An array of request HTTP headers, each with name and value
responseLine	The entire response line as a single field
responseHeadersRaw[]	All response headers as a single field (useful if the headers are malformed)
responseHeaders[]	An array of response HTTP headers, each with name and value
fragileServer	true if the server crashes when inspected by SSL Labs (in which case the full test is refused)

DrownHosts

Parameter	Description
ip	Ip address of server that shares same RSA-Key/hostname in its certificate
export	true if export cipher suites detected
port	Port number of the server
special	true if vulnerable OpenSSL version detected
sslv2	true if SSL v2 is supported
status	Drown host status: error - error occurred in test unknown - before the status is checked not_checked - not checked if already vulnerable server found not_checked_same_host - Not checked (same host) handshake_failure - when SSL v2 not supported by server sslv2 - SSL v2 supported but not same rsa key key_match - vulnerable (same key with SSL v2) hostname_match - vulnerable (same hostname with SSL v2)

Cert

Parameter	Description
id	Certificate ID
subject	Certificate subject
serialNumber	Certificate serial number (hex-encoded)
commonNames[]	Common names extracted from the subject
altNames[]	Alternative names
notBefore	Timestamp before which the certificate is not valid (Unix Timestamp)
notAfter	Timestamp after which the certificate is not valid (Unix Timestamp)
issuerSubject	Issuer subject
sigAlg	Certificate signature algorithm
revocationInfo	A number that represents revocation information present in the certificate: bit 0 (1) - CRL information available bit 1 (2) - OCSP information available
crlURIs[]	CRL URIs extracted from the certificate
ocspURIs[]	OCSP URIs extracted from the certificate
revocationStatus	A number that describes the revocation status of the certificate: 0 - not checked 1 - certificate revoked 2 - certificate not revoked 3 - revocation check error 4 - no revocation information 5 - internal error
crlRevocationStatus	Same as revocationStatus, but only for the CRL information (if any).
ocspRevocationStatus	Same as revocationStatus, but only for the OCSP information (if any).
dnsCaa	true if CAA is supported else false.
caaPolicy	CAA Policy, Null if CAA is not supported
mustStaple	true if stapling is supported else false
sgc	Server Gated Cryptography support; integer: bit 1 (1) - Netscape SGC bit 2 (2) - Microsoft SGC
validationType	E for Extended Validation certificates; may be null if unable to determine
issues	List of certificate issues, one bit per issue: bit 0 (1) - no chain of trust bit 1 (2) - not before bit 2 (4) - not after bit 3 (8) - hostname mismatch bit 4 (16) - revoked bit 5 (32) - bad common name bit 6 (64) - self-signed bit 7 (128) - blacklisted bit 8 (256) - insecure signature bit 9 (512) - insecure key
sct	true if the certificate contains an embedded SCT; false otherwise.
sha1Hash	sha1 hash of the certificate
sha256Hash	sha256 hash of the certificate
pinSha256	sha256 hash of the public key
keyAlg	Key algorithm.
keySize	Key size, in bits appropriate for the key algorithm.
keyStrength	Key strength, in equivalent RSA bits
keyKnownDebianInsecure	true if debian flaw is found, else false
raw	PEM-encoded certificate

CaaPolicy

Parameter	Description
policyHostname	hostname where policy is located
caaRecords[]	list of Supported CAARecord

CaaRecord

Parameter	Description
tag	A property of the CAA record
value	Corresponding value of a CAA property
flags	Corresponding flags of CAA property (8 bit)

StatusCodes

Parameter	Description
statusDetails	A map containing all status details codes and the corresponding English translations. Please note that, once in use, the codes will not change, whereas the translations may change at any time.