CertStore AddCertStoreServer

Some certificate stores are managed by agents accessing the store through a third-party Web 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.. This currently includes F5 BigIP devices and Citrix NetScaler devices. These stores require the definition of a certstore server before the store itself can be defined in Keyfactor Command. Each server can be configured with a location and user credentials to access the client machine via the appropriate third-party 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.. This Keyfactor Command Web API method allows such configuration. The structure shown in Table 700: POST /AddCertStoreServer Request Body should be used for requests.

Table 700: POST /AddCertStoreServer Request Body

Parameter Name

Parameter Value

Name

Hostname of the machine the agent will connect to.

ServerType

Platform for this server, defining what certstore types are supported. Allowed values are:

Parameter Name

Parameter Value

0

F5

1

NetScaler

UseSSL

Boolean denoting whether the agent should connect to the client API using https or http.

Username

Username to provide to the client API.

Password

Password corresponding to the login for the given Username to access the client API.

Table 701: POST /AddCertStoreServer Response Body

Parameter Name

Parameter Value

Result

Status code for the operation. Will take one of the following values:

Value

Description

1

Success

2

Failure

3

Warning

Message

Description of the operation outcome, e.g. "The operation completed successfully".

Example Request

POST http://<host>/CMSApi/CertStore/1/AddCertStoreServer HTTP/1.1

{
	"Name": "192.168.23.100",
	"UseSSL" : true,
	"Username": "nsroot",
	"Password": "nsroot",
	"ServerType": 1 
}

Example Response

{
	"Result": 1,
	"Message": "The operation completed successfully."
}