DELETE Certificates Exclude 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 removed from the main tables of the Keyfactor Command database and excluded from all Keyfactor Command functionality. These certificates will be skipped and not re-imported 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. synchronization or manual import (see Delete And Exclude).

Important:  When a certificate is deleted with exclusion, it will not be re-imported during a CA synchronization or add certificate task. However, it will be re-imported if it is found on 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 in a certificate store configured for inventory. This ensures that certificates that are still used in the environment are still tracked. 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—see CollectionID, below)

Permissions for certificates can be configured at multiple levels. You can apply them system-wide—for all certificates—or use fine-grained control by assigning permissions at the 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. The appropriate level depends on how the certificates are accessed. See Certificate Collection Permissions for more information about system-wide versus more targeted permission models.

Table 330: DELETE Certificates Exclude Query 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 optional integer that specifies the certificate collection (CollectionId) to validate whether the user has sufficient permissions to perform the action. If a CollectionId is not provided, the user must have appropriate permissions granted system-wide or via certificate store containers.

Providing a CollectionId allows the system to check the user's permissions at the certificate collection level. Permissions are evaluated in the following order:

  1. System-wide certificate permissions
  2. Granular certificate permissions

Use either ContainerId or CollectionId, not both. If both are specified, CollectionId takes precedence, and the ContainerId is ignored (defaults to 0).

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.