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 Roles and Claims) are required to use this feature:

/ssl/read/

Table 747: 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 API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns. For querying guidelines, refer to: Using the Discovery Results Search Feature. The query fields supported for this endpoint 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 748: GET SSL Response Data

Name Description
EndpointId A string indicating the Keyfactor Command reference GUID for the endpoint.
ReverseDNS A string indicating the DNS name resolved for the endpoint based on the discovered IP address. If a host name could not be resolved, this will be the IP address.
SNIName A string indicating the server name indication (SNI) 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 orchestrator 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 name of the certificate that was found at the endpoint.
Reviewed A Boolean indicating whether the endpoint has been reviewed (true) or not (false).
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor 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. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflowClosed A workflow is a series of steps necessary to complete a process. In the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the top of the Management Portal page next to the Log Out button.