PUT SSL Networks

The PUT /SSLClosed TLS (Transport Layer Security) and its predecessor SSL (Secure Sockets Layer) are protocols for establishing authenticated and encrypted links between networked computers./Networks method is used to update an SSL network in Keyfactor Command. This method returns HTTP 200 OK on a success with details for the SSL network.

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

/ssl/modify/

Important:  Any previously populated fields that are not submitted with their full existing data using this method will be cleared of their existing data. When using this method, you should first do a GET to retrieve all the values for the record you want to update, enter corrected data into the field(s) you want to update, and then submit all the fields using PUT, including the fields that contain values but which you are not changing.

Table 852: PUT SSL Networks Input Parameters

Name In Description
Network Id Body A string indicating the Keyfactor Command reference GUID for the SSL network. This GUID is automatically set by Keyfactor Command.
Name Body

Required. A string indicating the name for the SSL network.
Agent Pool Name Body Required. A string indicating the name of the orchestrator pool assigned to the SSL network. See for more information.
Agent Pool Id Body A string indicating the Keyfactor Command reference GUID for the orchestrator pool assigned to the SSL network.
Description Body Required. A string indicating the description of the SSL network.
Enabled Body A Boolean that indicates whether scanning is enabled for the SSL network (true) or not (false). If this is set to false, no new network scans will be scheduled but any current scan will finish if one was in progress when the status was changed from true to false.
Discover Schedule Body

An object providing the discovery schedule for the SSL network group. The schedule can be off (unset) or one of the supported values. ClosedShow schedule details.
Monitor Schedule Body

An object providing the monitoring schedule for the SSL network group. The schedule can be off (unset) or one of the supported values. ClosedShow schedule details.
Discover Percent Complete Body An integer indicating the percentage complete for a discovery job. The percentage complete will be zero for small jobs for the entire duration of the job because this value is updated upon completion of each segment of a scan job (and small jobs generally consist of only one segment). All jobs will show 100% at completion. The counter resets when a new job begins. This field is for reference and is not configurable.
Monitor Percent Complete Body An integer indicating the percentage complete for a monitoring job. The percentage complete will be zero for small jobs for the entire duration of the job because this value is updated upon completion of each segment of a scan job (and small jobs generally consist of only one segment). All jobs will show 100% at completion. The counter resets when a new job begins. This field is for reference and is not configurable.
Discover Status Body

An integer indicating the status of the discovery job. ClosedShow discovery status details.
Monitor Status Body

An integer indicating the status of the monitoring job. ClosedShow monitor status details.
Discover Last Scanned Body A string indicating the date and time, in UTC, of the most recent discovery job. This field is populated as soon as the job is initiated and updated when the job completes. This field is for reference and is not configurable.
Monitor Last Scanned Body A string indicating the date and time, in UTC, of the most recent monitoring job. This field is populated as soon as the job is initiated and updated when the job completes. This field is for reference and is not configurable.
Ssl Alert Recipients Body An array of strings providing the list of recipients who will receive email messages regarding the status of SSL discovery and monitoring jobs.
Note:  To improve performance in requests, data is not returned in this field for the GET /SSL/Networks method. Use the GET /SSL/Networks/{id} method to return data in this field.
Get Robots Body A Boolean that indicates whether orchestrators should perform a GET /robots.txt request during scans in order to behave like a webcrawler and provide an explanation of network activity (true) or not (false).
Discover Timeout Ms Body An integer that indicates the amount of time (in milliseconds) the scan will wait (before timing out) to discover the endpoint. Shorter timeout periods will increase the overall scanning throughput, however they will also increase the chance of missing a certificate on a slow or congested network.
Monitor Timeout Ms Body An integer that indicates the amount of time (in milliseconds) the scan will wait (before timing out) to receive the discovered endpoint certificate expiration details.
Expiration Alert Days Body An integer that indicates the number of days within which to begin providing warnings regarding upcoming expiration in notification email messages.
Discover Job Parts Body An integer that indicates the number of job parts that have been created for a discovery job. This field is for reference and is not configurable.
Monitor Job Parts Body An integer that indicates the number of job parts that have been created for a monitoring job. This field is for reference and is not configurable.
Quiet Hours Body An array of objects providing the list of scheduled quiet hour periods. For example:
Copy
"QuietHours": [
   {
      "StartDay": "Monday",
      "StartTime": "2022-11-21T14:00:08Z",
      "EndDay": "Tuesday",
      "EndTime": "2022-11-22T14:00:08Z"
   },
   {
      "StartDay": "Saturday",
      "StartTime": "2022-11-26T04:00:08Z",
      "EndDay": "Sunday",
      "EndTime": "2022-11-27T16:00:08Z"
   }
]
Blackout Start Body

An object providing the start day and time for the first scheduled quiet hours period. See QuietHours for the full list of scheduled quiet hours. If both a Blackout period and a QuietHours period are configured for the same network, the QuietHours period will be used.

This is considered deprecated and may be removed in a future release.
Blackout End Body

An object providing the ending day and time for the first scheduled quiet hours period. See QuietHours for the full list of scheduled quiet hours. If both a Blackout period and a QuietHours period are configured for the same network, the QuietHours period will be used.

This is considered deprecated and may be removed in a future release.

Table 853: PUT SSL Networks Response Data

Name Description
Network Id A string indicating the Keyfactor Command reference GUID for the SSL network. This GUID is automatically set by Keyfactor Command.
Name

A string indicating the name for the SSL network.
Agent Pool Name A string indicating the name of the orchestrator pool assigned to the SSL network. See Orchestrator Pools Definition for more information.
Agent Pool Id A string indicating the Keyfactor Command reference GUID for the orchestrator pool assigned to the SSL network.
Description A string indicating the description of the SSL network.
Enabled A Boolean that indicates whether scanning is enabled for the SSL network (true) or not (false). If this is set to false, no new network scans will be scheduled but any current scan will finish if one was in progress when the status was changed from true to false.
Discover Schedule

An object providing the discovery schedule for the SSL network group.

Monitor Schedule

An object providing the monitoring schedule for the SSL network group.

Discover Percent Complete An integer indicating the percentage complete for a discovery job. The percentage complete will be zero for small jobs for the entire duration of the job because this value is updated upon completion of each segment of a scan job (and small jobs generally consist of only one segment). All jobs will show 100% at completion. The counter resets when a new job begins.
Monitor Percent Complete An integer indicating the percentage complete for a monitoring job. The percentage complete will be zero for small jobs for the entire duration of the job because this value is updated upon completion of each segment of a scan job (and small jobs generally consist of only one segment). All jobs will show 100% at completion. The counter resets when a new job begins.
Discover Status

An integer indicating the status of the discovery job. ClosedShow discovery status details.
Monitor Status

An integer indicating the status of the monitoring job. ClosedShow monitor status details.
Discover Last Scanned A string indicating the date and time, in UTC, of the most recent discovery job. This field is populated as soon as the job is initiated and updated when the job completes.
Monitor Last Scanned A string indicating the date and time, in UTC, of the most recent monitoring job. This field is populated as soon as the job is initiated and updated when the job completes.
Ssl Alert Recipients An array of strings providing the list of recipients who will receive email messages regarding the status of SSL discovery and monitoring jobs.
Note:  To improve performance in requests, data is not returned in this field for the GET /SSL/Networks method. Use the GET /SSL/Networks/{id} method to return data in this field.
Auto Monitor A Boolean that indicates whether automatic monitoring of discovered endpoints is enabled (true) or not (false).
Get Robots A Boolean that indicates whether orchestrators should perform a GET /robots.txt request during scans in order to behave like a webcrawler and provide an explanation of network activity (true) or not (false).
Discover Timeout Ms An integer that indicates the amount of time (in milliseconds) the scan will wait (before timing out) to discover the endpoint. Shorter timeout periods will increase the overall scanning throughput, however they will also increase the chance of missing a certificate on a slow or congested network.
Monitor Timeout Ms An integer that indicates the amount of time (in milliseconds) the scan will wait (before timing out) to receive the discovered endpoint certificate expiration details.
Expiration Alert Days An integer that indicates the number of days within which to begin providing warnings regarding upcoming expiration in notification email messages.
Discover Job Parts An integer that indicates the number of job parts that have been created for a discovery job.
Monitor Job Parts An integer that indicates the number of job parts that have been created for a monitoring job.
Quiet Hours An array of objects providing the list of scheduled quiet hour periods.
Blackout Start

An object providing the start day and time for the first scheduled quiet hours period. See QuietHours for the full list of scheduled quiet hours. If both a Blackout period and a QuietHours period are configured for the same network, the QuietHours period will be used.

This is considered deprecated and may be removed in a future release.
Blackout End

An object providing the ending day and time for the first scheduled quiet hours period. See QuietHours for the full list of scheduled quiet hours. If both a Blackout period and a QuietHours period are configured for the same network, the QuietHours period will be used.

This is considered deprecated and may be removed in a future release.
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.