DELETE Certificates Query
The DELETE /Certificates/query method is used to delete a group of active certificates from Keyfactor Command that match the criteria provided in the body. This endpoint
An endpoint is a URL that enables the API to gain access to resources on a server. returns 204 with no content upon success.
Certificate permission can be granted at either the global or collection 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 note under CollectionId, below.
Table 218: DELETE Certificates Query Input Parameters
| Name | In | Description |
|---|---|---|
| sq | Body | Required. Query to limit the requested set of certificates that should be deleted in the form (without parameter A parameter or argument is a value that is passed into a function in an application. name): "CN –contains \"mycertificate.keyexample.com\"" See Certificate Search Page section of the Keyfactor Command Reference Guide for querying guidelines to build your body query. Tip: Revoked and expired certificates are excluded from the selection regardless of the query you enter. |
| 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 Permissions in the Keyfactor Command Reference Guide for more information. |
