GET Certificate Authority Alert Recipients CA Health Recipients ID

The GET /CertificateAuthority/AlertRecipients/CAHealthRecipients/{id} method is used to retrieve 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 recipient configured in Keyfactor Command with the specified ID. This method returns HTTP 200 OK on a success with the details for the recipient.

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

/certificate_authorities/read/

Table 356: GET Certificate Authority Alert Recipients CA Health Recipients {id} Input Parameters

Name In Description
id Path

Required. An integer that specifies the Keyfactor Command reference ID of the certificate authority health monitoring recipient record to retrieve.

Use the GET /CertificateAuthority/AlertRecipients/CAHealthRecipients method (see GET Certificate Authority Alert Recipients CA Health Recipients) to retrieve the ID.

Table 357: GET Certificate Authority Alert Recipients CA Health Recipients {id} Response Body

Name

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

Email

A string indicating the email address of the recipient.
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.