POST Certificate Stores Server

The POST /CertificateStores/Server method is used to create a new server record for a certificate store in Keyfactor Command. This method returns HTTP 200 OK on a success with details of the newly created 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. Creating new 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. Certificate store server information is now found in the Properties field of the certificate store (see POST Certificate Stores).
Tip:  If a certificate store that requires a server is missing a server definition within the store record, the certificate store server created with this method will be used. If no credentials are supplied in the request and no certificate store server exists, an error is returned and the request fails.

Table 332: POST Certificate Stores Server Input Parameters

Name In Description
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.
ServerType Body

An integer indicating the type of server. ClosedShow server type details (your environment may include custom values not shown here).

Use the GET /CertificateStoreTypes method (see GET Certificate Store Types) to locate the server types for your custom certificate store types. The ServerRegistration value returned by that method maps to the ServerType.

The default is 0.
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 333: POST 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.