DELETE Certificates Excluded Certificates

The DELETE /Certificates/ExcludedCertificates method is used to remove the specified certificate(s) from the excluded certificates table—in other words, to re-include them—thus allowing them to return to the Keyfactor Command database on the next 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 import. If a certificate is re-included, associated data (e.g., metadataClosed Metadata provides information about a piece of data. It is used to summarize basic information about data, which can make working with the data easier. In Keyfactor Command, the certificate metadata feature allows you to create custom metadata fields that allow you to tag certificates with tracking information about certificates.) will not be re-included when it is imported on the next CA synchronization. The certificate thumbprints should be supplied in the request body as a JSON array of strings. If the specified certificate(s) have associated private keyClosed Private keys are used in cryptography (symmetric and asymmetric) to encrypt or sign content. In asymmetric cryptography, they are used together in a key pair with a public key. The private or secret key is retained by the key's creator, making it highly secure.(s) stored in the database, these private keys are also removed. 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. IDs of any certificates that could not be deleted are returned in the response body. Delete operations will continue until the entire array of IDs has been processed.

Whenever a certificate that is part of a certificate renewal chain is deleted, the certificates on either end of the deleted certificate will have their certificate histories updated. The update will reflect the deletion of the certificate in the renewal chain, showing either the certificate before or after the deleted certificate.

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 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/

Table 348: DELETE Certificates Excluded Certificates Input Parameters

Name In Description
CertificateThumbprints Body Required. An array of strings containing the thumbprints of the certificates on the excluded certificates list that should be deleted.
{"CertificateThumbprints": ["string"]}

Use the GET /Certificates/Excluded Certificates method (see GET Certificates Excluded Certificates) to determine the certificate thumbprints.
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.