GET SSL Parts ID

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./Parts/{id} method retrieves information for a specific job scan segment (see GET SSL Networks ID Parts ). This method returns HTTP 200 OK on a success with details about the specified scan job segment.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/ssl/read/

Table 843: GET SSL Parts {id} Input Parameters

Name In Description
id Path Required. The Keyfactor Command reference GUID for the SSL scan job segment to be retrieved.

Use the GET /SSL/Networks/{id}/Parts method (see GET SSL Networks ID Parts ) to retrieve a list of all the scan job segments in an SSL network to determine the SSL scan job segment's GUID.

Table 844: GET SSL Parts {id} Response Data

Parameter Name Description
ScanJobPartId A string indicating the Keyfactor Command reference GUID for the scan job segment.
LogicalScanJobId A string indicating the Keyfactor Command reference GUID for the scan job as a whole.
AgentJobId A string indicating the Keyfactor Command reference GUID for the orchestrator that ran the job segment, if applicable. If the segment has not yet started scanning, this will show all zeros.
EstimatedEndpointCount

An integer indicating the number of endpoints that will be scanned for the segment estimated in preparation for scanning.

The number of endpoints per segment is configurable (see the SSL Maximum Scan Job Size setting on the agents tab in Application Settings: Agents Tab in the Keyfactor Command Reference Guide).
Status

An integer indicating the status of the scan job segment. ClosedShow status values.
StatTotalEndpointCount An integer indicating the number of endpoints that were be scanned for the segment. This value will be null if the scan is not yet complete.
StatTimedOutConnectingCount An integer indicating the number of endpoints that timed out while attempting connections. This value will be null if the scan is not yet complete.
StatConnectionRefusedCount An integer indicating the number of endpoints that received a connection refused while attempting connections. This value will be null if the scan is not yet complete.
StatTimedOutDownloadingCount An integer indicating the number of endpoints that timed out while downloading while attempting connections. This value will be null if the scan is not yet complete.
StatExceptionDownloadingCount An integer indicating the number of endpoints that encountered an exception while attempting connections. This value will be null if the scan is not yet complete.
StatNotSslCount An integer indicating the number of endpoints that made a connection and were considered not SSL (connection on a non-SSL port such as 22 or 636). This value will be null if the scan is not yet complete.
StatBadSslHandshakeCount An integer indicating the number of endpoints that had a bad handshake while attempting connections. This value will be null if the scan is not yet complete.
StatCertificateFoundCount An integer indicating the number of endpoints where a certificate was found. This value will be null if the scan is not yet complete.
StatNoCertificateCount An integer indicating the number of endpoints where the handshake got to the part of the TLS where a certificate should be returned, but did not find a certificate. This is an uncommon occurrence, so will usually be zero.
ScanJobPartsDefinitions This is no longer in use and will always return “null”.
StartTime A string indicating the date and time at which the scan job segment started in UTC. For jobs that have not yet started, this value will be null.
EndTime A string indicating the date and time at which the scan job segment finished in UTC. For jobs that have not yet started, this value will be null.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed An API is 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 Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. 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.