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, IIS, Citrix\NetScaler, and any other custom method you've defined to support this. This method returns HTTP 200 OK on a success with details for each server.
Permissions for certificate stores can be set at either the global or certificate store container level. See Container Permissions for more information about global vs container permissions.
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 Properties field of the certificate store (see GET Certificate Stores).Table 326: 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: Using the Certificate Store Search Feature. The query fields supported for this endpoint are:
|
| 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. |
| SkipCount | Query | An integer indicating the number of records that should be skipped in providing results, starting from the beginning of the records (for pagination). This field is optional and no records will be skipped if not provided. |
| 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 327: 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 SSL to communicate with the server (true) or not (false). |
| ServerType |
An integer indicating the type of server. |
| Name | The host name of the server. |
A workflow is a series of steps necessary to complete a process. In the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked. 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.