DELETE Metadata Fields

The DELETE /MetadataFields method is used to delete multiple 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. fields in one request. Delete operations will continue until the entire array of IDs has been processed. Note that metadata fields that are in use for any certificate cannot be deleted unless the force=true parameterClosed A parameter or argument is a value that is passed into a function in an application. is included in the request. 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.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/metadata/types/modify/

Table 520: DELETE Metadata Fields Input Parameters

Name In Description
ids Body Required. An array of integers indicating the Keyfactor Command reference IDs for the metadata fields to be deleted.

Use the GET /MetadataFields method (see GET Metadata Fields) to retrieve a list of all the metadata fields to determine the metadata field IDs.
Force Query

A Boolean that sets whether to force deletion of the metadata fields even if they are in use (true) or not (false). The default is False.

Use the GET /MetadataFields/{id}/InUse method (see GET Metadata Fields ID In Use) to determine whether a metadata field is in use.
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.