Status

The Status Web API 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. component provides a single method to retrieve various aspects of the Keyfactor Command server state. This method is an HTTP GET Status request with no parameters required. As of Keyfactor Command 5.0, the Status endpoint An endpoint is a URL that enables the API to gain access to resources on a server. generally is not needed by a Web API 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. client application, as the Keyfactor Command version is passed back in an HTTP header with every response to every Web API request. However, it is included to preserve compatibility with applications already using it or applications requiring more information.

Example Request

GET http://<host>/CMSApi/Status HTTP/1.1

Example Response

Status Code: 200

{
	"ApiMajorRev": 2,
	"ApiMinorRev": 0,
	"ProductMajorVersion": 5,
	"ProductMinorVersion": 0,
	"ProductBranchVersion": 0,
	"ProductBuildVersion": 1,
	"LicenseStatus": "Licensed",
	"Modules": [{
		"Name": "CertEnroll",
		"Versions": [1, 2, 3]
	},
	{
		"Name": "Certificates",
		"Versions": [1, 2, 3]
	},
	{
		"Name": "CertStore",
		"Versions": [1]
	},
	{
		"Name": "Metadata",
		"Versions": [2, 3]
	},
	{
		"Name": "Ssl",
		"Versions": [1]
	},
	{
		"Name": "Status",
		"Versions": null
	},
	{
		"Name": "Workflow",
		"Versions": [1]
	}]
}