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 Roles and Claims) are required to use this feature:
/certificate_stores/modify/
OR
/certificate_stores/modify/#/ (where # is a reference to a specific certificate store container ID)

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 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 a future release. This method is retained until that time for backwards compatibility. Continuing to use this endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. with the latest Keyfactor Command functionality could cause serious data issues such as, for instance, overwriting all certificate stores on the server. Certificate store server information is now found in the Properties field of the certificate store (see PUT Certificate Stores. This endpoint has additional functionality, such as being able to set different credentials for different stores on the same server.
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 334: 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 SSL to communicate with the server (true) or not (false). The default is false.
Name Body Required. The host name 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.

Table 335: 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.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor API 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 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.