GET Certificate Authority Health Monitoring Schedule

The GET /CertificateAuthority/HealthMonitoring/Schedule method is used to retrieve the current schedule for the CAClosed 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. health monitoring job This method returns HTTP 200 OK on a success with the list of schedule settings. This method has no input parameters other than the standard headers (see Endpoint Common Features).

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/certificate_authorities/read/

Table 296: GET Certificate Authority Health Monitoring Schedule Response Body

Name

Description
Id An integer indicating the Keyfactor Command reference ID of the schedule.

Schedule

A string indicating the schedule for the health monitoring job. Schedules are shown in cron syntax. For an interval schedule, this will look like I_mm where mm is the number of minutes (e.g. I_30 for every 30 minutes). For daily schedules, this will look like D_hh:mm where hh:mm is the time to run the job (e.g. D_14:30 for daily at 2:30 pm).

ScheduleType

An integer indicating the type of schedule. Health monitoring schedules have type 10.

Enabled

A Boolean that indicates whether health monitoring is enabled (true) or not (false).
Name A string indicating the Keyfactor Command reference name of the health monitoring job. This is the name that appears in log output for the job.
EntityId An internally used Keyfactor Command field.
LastRun

A string indicating the last run time of the job in ISO 8601 UTC time format (e.g. 2023-05-19T16:23:01Z).
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed 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. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the top of the Management Portal page next to the Log Out button.