DELETE Certificates Exclude Query

The DELETE /Certificates/Exclude/Query operation deletes and excludes a group of certificates from Keyfactor Command that match the provided criteria. On success, the operation returns 204 with no content.

Excluded certificates are removed from active use in Keyfactor Command and are no longer included in standard operations. These certificates are 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 and returns certificates that exist in both the certificate inventory and 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/#/

Permissions for certificates can be set at the system-wide or resource-specific level. The appropriate level depends on how the certificates are accessed. See Certificate Collection Permissions for more information.

In permission strings, # represents a specific resource identifier. In /certificates/collections/ permission strings it refers to a certificate collection ID (for example, CollectionId) and in /certificate_stores/ permission strings it refers to a certificate store application ID (for example, containerId).

Table 309: 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 Searching Certificates 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 applications.

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 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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended 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, and also serves as an interactive supplement to this API documentation. You can access it from the help menu () in the Management Portal.