DELETE Exclude Certificates Query

The DELETE /Certificates/Exclude/Query method is used to delete and exclude a group of certificates from Keyfactor Command that match the criteria provided in the query string. This endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. returns 204 with no content upon success.

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 or
/certificates/collections/delete_and_exclude/#/ (where # is a reference to a specific certificate collection ID)

Permissions for certificates can be set at either the global or certificate collectionClosed The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be availble in other places in the Management Portal (e.g. expiration alerts and certain reports). level. See Certificate Collection Permissions for more information about global vs collection permissions. See also the CollectionId input parameterClosed A parameter or argument is a value that is passed into a function in an application., below.

Table 294: DELETE Certificates Input Parameters

Name In Description
query Body Required. A string representing a query to limit the requested set of certificates that should be deleted and excluded in the form (without parameter name):
CN –contains "mycertificate.keyexample.com"

See Certificate Search Page for querying guidelines to build your body query.
CollectionId Query

An integer specifying an optional certificate collection identifier to validate that the user executing the request has sufficient permissions to do so. If a certificate collection ID is not supplied, the user must have global permissions to complete the action. Supplying a certificate collection ID allows for a check of the user's certificate collection-level permissions to determine whether the user has sufficient permissions at a collection level to complete the action. See Certificate Collection Permissions for more information.

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.