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. changes for this release of Keyfactor Command.
Table 891: API Change Log v10.0
| Endpoint | Methods | Action | Notes |
|---|---|---|---|
| /Agents/ {id} | GET | Add | |
| /Agents/ Reset | POST | Add | |
| /Agent Blueprint | GET | Add | |
| /Agent Blueprint/ {id} | GET, DELETE | Add | |
| /Agent Blueprint/ {id}/ Jobs | GET | Add | |
| /Agent Blueprint/ {id}/ Stores | GET | Add | |
| /Agent BluePrint/ ApplyBlueprint | POST | Add | |
| /Agent BluePrint/ Generate BluePrint | POST | Add | |
| /Alerts/ Denied | GET, PUT, POST | Add | |
| /Alerts/ Denied/ {id} | GET, DELETE | Add | |
| /Alerts/ Expiration | GET, PUT, POST | Add | |
| /Alerts/ Expiration/ {id} | GET, DELETE | Add | |
| /Alerts/ Expiration/ Schedule | GET, PUT | Add | |
| /Alerts/ Expiration/ Test | POST | Add | |
| /Alerts/ Expiration/ TestAll | POST | Add | |
| /Alerts/ IssuedAlerts | GET, PUT, POST | Add | |
| /Alerts/ IssuedAlerts/ {id} | GET, DELETE | Add | |
| /Alerts/ Issued/ Schedule | GET, PUT | Add | |
| /Alerts/ KeyRotation | GET, PUT, POST | Add | |
| /Alerts/ KeyRotation/ {id} | GET, DELETE | Add | |
| /Alerts/ KeyRotation/ Schedule | GET, PUT | Add | |
| /Alerts/ KeyRotation/ Test | POST | Add | |
| /Alerts/ KeyRotation/ TestAll | POST | Add | |
| /Alerts/ Pending | GET, PUT, POST | Add | |
| /Alerts/ Pending/ {id} | GET, DELETE | Add | |
| /Alerts/ Pending/ Schedule | GET, PUT | Add | |
| /Alerts/ Pending/Test | POST | Add | |
| /Alerts/ Pending/ Test/ {id} | POST | Add | |
| /Certificate Authorities | GET | Update | Schedules are now included in the results. |
| /Certificate Authorities | POST | Update | Ability to turn off schedules, sessions are abandoned properly, and threshold monitoring schedule is included. |
| /Certificate Authorities/ {id} | PUT | Update | Ability to turn off schedules, sessions are abandoned properly, and threshold monitoring schedule is included. |
| /Certificate Authorities/ {id} | DELETE | Update | Deletion is now prevented if schedules are associated. |
| /Certificate Collections | POST | Update | Query parameter no longer needed when a valid CopyFromId is provided. |
| /Certificate Collections/ {id}/ Permissions | POST | Deprecated | Replaced by /Security/Roles/{id}/Permissions/Collection. |
| /Certificates/ Analyze | POST | Add | |
| /Certificates/ IdentityAudit/ {id} | GET | Add | |
| /Certificate Store Containers | POST | Add | |
| /Certificate Store Containers/{id} | PUT, DELETE | Add | |
| /Certificate Stores/ Server | GET, POST, PUT | To Be Deprecated | Server usernames, server passwords, and the UseSSL flag are managed by the /CertificateStores API endpoints directly as JobProperties using the Properties parameter, replacing the deprecated /CertificateStores/Server API endpoints. |
| /Certificate Stores | GET, POST, PUT | Updated | Server usernames, server passwords, and the UseSSL flag are managed by the /CertificateStores API endpoints directly as JobProperties using the Properties parameter, replacing the deprecated /CertificateStores/Server API endpoints. |
| /Enrollment/ PFX (v2) | POST | Add | |
| /Enrollment/ Settings/ {id} | GET | Add | |
| /JobTypes/ Custom | POST | Update | DefaultValue property is no longer required, validation is now performed on the JobTypeFields/DefaultValue property, validation prevents names containing spaces. |
| /JobTypes/ Custom/ {id} | DELETE | Update | Includes validation so that deletion is prevented if at least one associated approved orchestrator implements the capability. |
| /MacEnrollment | GET, PUT | Add | |
| /Monitoring/ Revocation | GET, POST | Update | Renamed from /Workflow/RevocationMonitoring |
| /Monitoring/ Revocation/ {id} | GET, PUT, DELETE | Update | Renamed from /Workflow/RevocationMonitoring/{id} |
| /Monitoring/ Revocation/ Test | POST | Add | |
| /Monitoring/ Revocation/ TestAll | POST | Add | |
| /Orchestrators/ JobHistory | GET | Update | Added JobId field. |
| /Orchestrators/ ScheduledJobs | GET | Add | |
| /Orchestrator Jobs/ Reschedule | POST | Add | |
| /Orchestrator Jobs/ Unschedule | POST | Add | |
| /Orchestrator Jobs/ Acknowledge | POST | Add | |
| /Security/ Identities/ {id} | GET | Add | |
| /Security/ Roles/ {id}/ Identities | GET, POST | Add | |
| /Security/ Roles/ {id}/ Containers | GET, POST | Add | |
| /Security/ Roles/ {id}/ Copy | POST | Add | |
| /Security/ Roles/{id}/Permissions | GET | Add | |
| /Security/ Roles/ {id}/ Permissions/ Global | GET, POST, PUT | Add | |
| /Security/ Roles/ {id}/ Permissions/ Collections | GET, POST, PUT | Add | Replaced the /CertificateCollections/{id}/Permissions endpoint functionality. |
| /Security/ Roles/ {id}/ Permissions/ Containers | GET, POST, PUT | Add |
Returns only containers that have a permission set for the selected security role. |
| /SMTP | GET, PUT | Add | |
| /SMTP/ Test | POST | Add | |
| /Templates | GET, PUT | Update | Includes template-specific policy information. |
| /Templates/ {id} | GET | Update | Includes template defaults. |
| /Templates/ Settings | GET, PUT | Update | Includes global template policies. |
| /Template/ Subject Parts | GET | Add | |
| /Templates/ Global/ Settings | GET, PUT | Add | |
| /Templates/ Import | POST | Add | |
| /Workflow/ Certificates/ Pending | GET | Update | Now supports query fields of Requester and RequestType. |
| /Workflow/ Definitions/ Steps/ {extensionName} | GET | Add | |
| /Workflow/ Definitions/ {definitionId} | GET, PUT, DELETE | Add | |
| /Workflow/ Definitions | GET, POST | Add | |
| /Workflow/ Definitions/ Steps | GET | Add | |
| /Workflow/ Definitions/ Types | GET | Add | |
| /Workflow/ Definitions/ {definitionId}/ Steps | PUT | Add | |
| /Workflow/ Definitions/ {definitionId}/ Publish | POST | Add | |
| /Workflow/ Instances/ {instanceId} | GET, DELETE | Add | |
| /Workflow/ Instances | GET | Add | |
| /Workflow/ Instances/ My | GET | Add | |
| /Workflow/ Instances/ AssignedToMe | GET | Add | |
| /Workflow/ Instances/ {instanceId}/ Stop | POST | Add | |
| /Workflow/ Instances/ {instanceId}/ Signals | POST | Add | |
| /Workflow/ Instances/ {instanceId}/ Restart | POST | Add |