Alerts Key Rotation
The Alerts Key Rotation component of the Keyfactor 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. includes methods necessary to create, update, retrieve, schedule, and delete alerts for SSH
The SSH (secure shell) protocol provides for secure connections between computers. It provides several options for authentication, including public key, and protects the communications with strong encryption. keys approaching the end of the key lifetime. The default key lifetime is 365 days, but this setting is configurable (see Application Settings: SSH Tab). Key rotation alerts apply to both user keys (see My SSH Key Operations) and service account keys (see Service Account Key Operations) generated within Keyfactor Command.
Table 180: Alerts Key Rotation
Endpoint |
Method |
Description |
Link |
---|---|---|---|
/Alerts/KeyRotation/{id} |
DELETE |
Deletes an SSH key rotation alert for the specified ID. | DELETE Alerts Key Rotation ID |
/Alerts/KeyRotation/{id} |
GET |
Retrieves details for the SSH key rotation alert for the specified ID. |
GET Alerts Key Rotation ID |
/Alerts/KeyRotation/Schedule |
GET |
Retrieves details of the schedule for delivery of SSH key rotation alerts. |
GET Alerts Key Rotation Schedule |
/Alerts/KeyRotation/Schedule |
PUT |
Updates the schedule for delivery of SSH key rotation alerts. |
PUT Alerts Key Rotation Schedule |
/Alerts/KeyRotation |
GET |
Retrieves details for all configured SSH key rotation alerts. |
GET Alerts Key Rotation |
/Alerts/KeyRotation | POST |
Creates a new SSH key rotation alert. |
POST Alerts Key Rotation |
/Alerts/KeyRotation | PUT |
Updates the SSH key rotation alert for a specified ID. |
PUT Alerts Key Rotation |
/Alerts/KeyRotation/Test | POST | Used to test specific SSH key rotation alerts. | POST Alerts Key Rotation Test |
/Alerts/KeyRotation/TestAll | POST | Used to test all SSH key rotation alerts. | POST Alerts Key Rotation Test All |