GET Certificate Stores Server

The GET /CertificateStores/Server method is used to retrieve all servers for certificate stores. Only select types of certificate stores have an associated server. These include F5, FTP, NetScaler, and any custom method you've defined to support this. This method returns HTTP 200 OK on a success with details for each server.

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

CertificateStoreManagement: Read

Permissions for certificate stores can be set at either the global or certificate store container level. See Container Permissions in the Keyfactor Command Reference Guide for more information about global vs container permissions.

Note:  This method has been deprecated and will be removed from 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. in release 12. Certificate store server information is now found in the certificate store (see GET Certificate Stores).

Table 261: GET Certificate Stores Server 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). 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 Certificate Store Search Feature section. The query fields supported for this endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. are:

  • Id
  • Name
  • ServerType
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 Id.
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 262: GET Certificate Stores Server Response Data

Name Description
Id The ID of the server.
Username The username used to connect to the certificate store.
Note:  Secret data is stored in the secrets table or a PAM provider and is not returned in responses.
Password

The password used to connect to the certificate store.

Note:  Secret data is stored in the secrets table or a PAM provider and is not returned in responses.
UseSSL A Boolean that indicates whether Keyfactor Command will use SSLClosed TLS (Transport Layer Security) and its predecessor SSL (Secure Sockets Layer) are protocols for establishing authenticated and encrypted links between networked computers. to communicate with the server (true) or not (false).
ServerType

An integer indicating the type of server. ClosedShow server type details (your environment may include custom values not shown here).
Name The host nameClosed The unique identifier that serves as name of a computer. It is sometimes presented as a fully qualified domain name (e.g. servername.keyexample.com) and sometimes just as a short name (e.g. servername). of the server.