The GET /SSL
TLS (Transport Layer Security) and its predecessor SSL (Secure Sockets Layer) are protocols for establishing authenticated and encrypted links between networked computers./Endpoints/{id} method is used to retrieve information about an endpoint An endpoint is a URL that enables the API to gain access to resources on a server. found in an SSL discover or monitor scan using the EndpointId. This method returns HTTP 200 OK on a success with details of the SSL endpoints.
Tip: The following permissions (see Security Roles and Claims) are required to use this feature:
/ssl/read/
Table 787: GET SSL Endpoints {id} Input Parameters
| Name | In | Description |
|---|---|---|
| id | Path | Required. A string indicating the Keyfactor Command reference GUID for the SSL endpoint to be retrieved. Use the GET /SSL method (see GET SSL) to retrieve a list of all the SSL endpoints to determine the SSL endpoint's GUID. |
Table 788: GET SSL Endpoints {id} Response Data
| Name | Description |
|---|---|
| EndpointId | A string indicating the Keyfactor Command reference GUID for the endpoint. |
| NetworkId | A string indicating the Keyfactor Command reference GUID for the SSL network that scanned the endpoint. |
| LastHistoryId | A string indicating the Keyfactor Command reference GUID for the last history entry on the endpoint. |
| IpAddressBytes | A string indicating the IP address for the endpoint as bytes. |
| Port | An integer indicating the port on which this endpoint was found. |
| SNIName | A string indicating the server name indication (SNI) of the endpoint, if found. |
| EnableMonitor | A Boolean indicating whether monitoring is enabled on this endpoint (true) or not (false). |
| 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 API 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 workflow 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.
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 workflow 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.