GET SSL Networks ID Parts

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./Networks/{id}/Parts method returns a list of scan job segments for an SSL network defined in Keyfactor Command. This method returns HTTP 200 OK on a success with the scan job segments for the specified SSL network. The results will only include more than one segment if the SSL management job was broken up into segments due to the number of endpoints it contained. The number of endpoints per segment is configurable (see the SSL Maximum Discovery Scan Job Size and SSL Maximum Monitoring Scan Job Size settings in Application Settings: Agents Tab in the Keyfactor Command Reference Guide). The results from this method are of the currently in progress job or the latest completed job.

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

SslManagement: Read

Table 597: GET SSL Networks {id} Parts Input Parameters

Name In Description
ID Path Required. The Keyfactor Command reference GUID for the SSL network for which to retrieve scan job segments.

Use the GET /SSL/Networks method (see GET SSL Networks) to retrieve a list of all the SSL networks to determine the SSL network's GUID.
queryString Query

A string containing a query to limit the results (e.g. field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to the Keyfactor Command Reference Guide: Using the Network Scan Details Search.
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 Status.
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 598: GET SSL Networks {id} Parts Response Data

Name Description
ScanJobPartId A string indicating the Keyfactor Command reference GUID for the scan job segment.
Agent A string indicating the client machine name of the orchestrator that ran the scan job segment.
Status

An integer indicating the status of the scan job segment. ClosedShow scan job status values.
StartTime 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 The date and time at which the scan job segment finished in UTC. For jobs that are in progress, this value will be null.
EndpointCount An integer indicating the number of endpoints scanned for the segment.
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.