The CertificateAuthority component of the Keyfactor API
An API is 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. includes methods for listing, creating, updating and deleting certificate authority A certificate authority (CA) is an entity that issues digital certificates. Within Keyfactor Command, a CA may be a Microsoft CA or a Keyfactor gateway to a cloud-based or remote CA. records in Keyfactor Command as well as for publishing CRLs.
Table 281: Certificate Authority Endpoints
| Endpoint | Method | Description | Link |
|---|---|---|---|
| /PublishCRL | POST | Publish the Certificate Revocation List of the given certificate authority. | POST Certificate Authority PublishCRL |
| / | GET | Return a list of all certificate authorities. | GET Certificate Authority |
| / | POST | Create a new certificate authority record. | POST Certificate Authority |
| / | PUT | Update an existing certificate authority record. | PUT Certificate Authority |
| /{id} | GET | Return details for the certificate authority identified by the specified ID. | GET Certificate Authority ID |
| /{id} | DELETE | Delete the certificate authority record for the specified ID. | DELETE Certificate Authority ID |
| /Test | POST | Validate that the certificate authority with the provided information can be reached. | POST Certificate Authority Test |
| /SourceCount | GET | Retrieve the count of certificate authorities with full or incremental synchronization scans configured. | GET Certificate Authority Source Count |
| /AvailableForests | GET | Retrieve the list of forests in Active Directory Keyfactor Command. | GET Certificate Authority Available Forests |
| /Import | POST | Import into Keyfactor Command any certificate authorities from the provided configuration tenant DNS suffix (e.g. keyexample.com). | POST Certificate Authority Import |
| /HealthMonitoring/ Schedule | GET | Retrieve the current schedule for the CA health monitoring job. | GET Certificate Authority Health Monitoring Schedule |
| /TaskQueue | PUT | Add or update the credentials and connection information for RabbitMQ connectivity. | PUT Certificate Authority Task Queue |
| /TaskQueue | GET | Retrieve the connection information for RabbitMQ connectivity. | GET Certificate Authority Task Queue |
| /TaskQueue/ TEST | POST | Test the credentials and connection information for RabbitMQ connectivity. | POST Certificate Authority Task Queue Test |
| /CAConnectors | GET | Retrieve all the CA connector records defined in Keyfactor Command. | GET Certificate Authority CA Connectors |
| /CAConnectors | POST | Create a new CA connector record in Keyfactor Command. | POST Certificate Authority CA Connectors |
| /CAConnectors | PUT | Update a CA connector record in Keyfactor Command. | PUT Certificate Authority CA Connectors |
| /CAConnectors/ {id} | GET | Retrieve the CA connector record with the specified ID. | GET Certificate Authority CA Connectors ID |
| /CAConnectors/ {id} | DELETE | Delete the CA connector record with the specified ID. | DELETE Certificate Authority CA Connectors ID |
| /AlertRecipients/ CAHealth Recipients | POST | Create new recipients to receive CA health monitoring alerts in Keyfactor Command | POST Certificate Authority Alert Recipients CA Health Recipients |
| /AlertRecipients/ CAHealth Recipients | GET | Retrieve the list of recipients configured in Keyfactor Command for CA health monitoring alerts. | GET Certificate Authority Alert Recipients CA Health Recipients |
| /AlertRecipients/ CAHealth Recipients/ {id} | GET | Retrieve the CA health monitoring recipient configured in Keyfactor Command with the specified ID. | GET Certificate Authority Alert Recipients CA Health Recipients ID |
| /AlertRecipients/ CAHealth Recipients/ {id} | PUT | Update the CA health monitoring alert recipient with the specified ID. | PUT Certificate Authority Alert Recipients CA Health Recipients ID |
| /AlertRecipients/ CAHealth Recipients/ {id} | DELETE | Delete the CA threshold recipient with the specified Keyfactor Command reference ID. | DELETE Certificate Authority Alert Recipients CA Health Recipients ID |
| /AlertRecipients/ CAThreshold Recipients | POST | Create new recipients to receive CA threshold alerts in Keyfactor Command. | POST Certificate Authority Alert Recipients CA Threshold Recipients |
| /AlertRecipients/ CAThreshold Recipients | GET | Retrieve the list of recipients configured in Keyfactor Command for CA threshold alerts. | GET Certificate Authority Alert Recipients CA Threshold Recipients |
| /AlertRecipients/ CAThreshold Recipients/ {id} | GET | Retrieve the CA threshold recipient configured in Keyfactor Command with the specified ID. | GET Certificate Authority Alert Recipients CA Threshold Recipients ID |
| /AlertRecipients/ CAThreshold Recipients/ {id} | PUT | Update the CA threshold alert recipient with the specified ID. | PUT Certificate Authority Alert Recipients CA Threshold Recipients ID |
| /AlertRecipients/ CAThreshold Recipients/ {id} | DELETE | Delete the CA threshold recipient with the specified Keyfactor Command reference ID. | DELETE Certificate Authority Alert Recipients CA Threshold Recipients ID |