PUT Certificate Stores Server

The PUT /CertificateStores/Server method is used to update the server record for a certificate store in Keyfactor Command. This method returns HTTP 200 OK on a success with details of the server record.

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

CertificateStoreManagement: Modify

Permissions for certificate stores can be set at either the global or certificate store container level. Updating certificate store server records requires permissions at the global 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 PUT Certificate Stores).
Tip:  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 265: PUT Certificate Stores Server Input Parameters

Name In Description
Id Body The ID of the server.
Username Body Required. The username used to connect to the certificate store.ClosedShow username details.
Password Body

Required. The password used to connect to the certificate store.ClosedShow password details.
UseSSL Body 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). The default is false.
Name Body Required. 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.
Container Body An integer that identifies the certificate store container into which the certificate store should be placed for organizational and management purposes. This value must be specified if you are using PAM to store your username and/or password and your PAM provider has been configured to be linked to a specific certificate store container.

Table 266: PUT Certificate Stores Server Response Data

Name Description
Id The ID of the server.
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. ClosedShow server type details (your environment may include custom values not shown here).
Name The host name of the server.