GET Excluded Certificates

The GET /Certificates/ExcludedCertificates method is used to retrieves all the certificates in the excluded certificated list. This method returns HTTP 200 OK on a success withthe details of the certificate from the exclusion table. Excluded Certificates are certificates which have been deleted from the database and excluded from all Keyfactor Command functionality. These certificates will be skipped during a 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. sync or import (see Delete And Exclude).

Important:  Certificates that are found during an SSLClosed TLS (Transport Layer Security) and its predecessor SSL (Secure Sockets Layer) are protocols for establishing authenticated and encrypted links between networked computers. scan or certificate store inventory will not be skipped, even if they have been excluded from Keyfactor Command. In order that users have the ability to monitor such certificates, a query parser (IsExcluded) is included on the certificate search grid that returns any certificate that exists in both the certificates table and in the exclusion list.
Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:
/certificates/collections/delete_and_exclude

Table 281: Get Excluded Certificates Input Parameters

Name In Description
QueryString Query

A string containing a query to limit the results (e.g. field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to: Certificate Search Page. Issued CN, Thumbprint, Date Excluded
PageReturned Query An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1.
ReturnLimit Query An integer that specifies how many results to return per page. The default is 50. Very large values can result in long processing time.
SortField Query

A string containing the property by which the results should be sorted. Fields available for sorting through the API include: Issued CN, Thumbprint, Date Excluded
SortAscending Query An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending.

Table 282: Get Excluded Certificates Response Data

Name In Description
ID Body

An integer indicating the ID of the excluded certificate. This is a new ID for the certificate since it has been deleted from the Keyfactor Command database and added to the excluded certificates table.
CertificateThumbprint Body A string indicating the thumbprint of the certificate.
IssuedCN Body A string indicating the issued CN of the certificate.
ExcludingUser Body

A string indicating the username of the excluding user.
DateExcluded Body A string indicating the date the certificate was excluded in UTC format.
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.