GET SSL

The GET /SSLClosed TLS (Transport Layer Security) and its predecessor SSL (Secure Sockets Layer) are protocols for establishing authenticated and encrypted links between networked computers. method is used to return a list of all discovered SSL endpoints, limited by the provided parameters. This method returns HTTP 200 OK on a success with details about the requested endpoints.

Tip:  The following permissions (see Security Overview) are required to use this feature:

SslManagement: Read

Table 587: GET SSL Input Parameters

Name In Description
queryString Query

A string containing a query to limit the results (e.g. field1 -eq value1 AND field2 -gt value2). Fields available for querying through the APIClosed A set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns. For querying guidelines, refer to the Keyfactor Command Reference Guide Using the Discovery Results Search Feature section. The query fields supported for this endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. are:

  • AgentPoolName

  • NetworkName

  • CertificateCN

  • Port

  • CertificateFound (True, False)

  • ReverseDNS

  • Status ( 6-Certificate Found, 1-Timed Out Connecting, 2-Exception Connecting, 3-Timed Out Downloading, 4- Exception Downloading, 5-Not SSL, 7-Exception in Sql, 8-Invalid or Unreachable Host, 9-Connection Refused, 10-Bad SSL Handshake, 11-Client Authentication Failed, 12-No Certificate, 13-SSL Refused, 14-Not Probed, 0-Unknown)

  • Reviewed (True, False)

  • IpAddress

  • SelfSigned (True, False)

  • IsMonitored (True, False)

  • SNIName

  • IssuerDN
 
pageReturned Query An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1.
returnLimit Query An integer that specifies how many results to return per page. The default is 50.
sortField Query A string containing the property by which the results should be sorted. Fields available for sorting through the API for the most part match those that appear as sortable columns in the Keyfactor Command Management Portal. The default sort field is ReverseDNS.
sortAscending Query An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending.

Table 588: GET SSL Response Data

Name Description
EndpointId The Keyfactor Command reference GUID for the endpoint.
ReverseDNS A string indicating the DNSClosed The Domain Name System is a service that translates names into IP addresses. name resolved for the endpoint based on the discovered IP address. If a host nameClosed The unique identifier that serves as name of a computer. It is sometimes presented as a fully qualified domain name (e.g. servername.keyexample.com) and sometimes just as a short name (e.g. servername). could not be resolved, this will be the IP address.
SNIName A string indicating the server name indicationClosed Server name indication (SNI) is an extension to TLS that provides for including the hostname of the target server in the initial handshake request to allow the server to respond with the correct SSL certificate or allow a proxy to forward the request to the appropriate target. (SNIClosed Server name indication (SNI) is an extension to TLS that provides for including the hostname of the target server in the initial handshake request to allow the server to respond with the correct SSL certificate or allow a proxy to forward the request to the appropriate target.) of the endpoint, if found.
IpAddress A string indicating the IP address of the endpoint.
Port An integer indicating the port at which the endpoint was found.
CertificateFound A Boolean indicating whether a certificate was found at the endpoint (true) or not (false).
AgentPoolName A string indicating the name of the orchestratorClosed Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. pool that performed a scan (discovery or monitoring) on the endpoint.
NetworkName A string indicating the name of the SSL network that performed a scan (discovery or monitoring) on the endpoint.
MonitorStatus A Boolean indicating whether the endpoint should be monitored (true) or not (false).
CertificateCN A string indicating the common nameClosed A common name (CN) is the component of a distinguished name (DN) that represents the primary name of the object. The value varies depending on the type of object. For a user object, this would be the user's name (e.g. CN=John Smith). For SSL certificates, the CN is typically the fully qualified domain name (FQDN) of the host where the SSL certificate will reside (e.g. servername.keyexample.com or www.keyexample.com). of the certificate that was found at the endpoint.
Reviewed A Boolean indicating whether the endpoint has been reviewed (true) or not (false).
Tip:  For code examples, see the Keyfactor API Endpoint Utility. To find the embedded web copy of this utility, click the help icon () at the top of the Keyfactor Command Management Portal page next to the Log Out button.