PUT Certificates Metadata All
The PUT /Certificates/Metadata 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./All method is used to update one or more metadata values for a specified set of certificates. 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.
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 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. 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 315: PUT Certificates Metadata All Input Parameters
Name |
In |
Description |
---|---|---|
Query | Body |
Required in some cases. A string containing a query to limit the certificates to update (e.g., field1 -eq value1 AND field2 -gt value2). Fields available for querying through the API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns. For querying guidelines, refer to: Certificate Search Page. A value for one of CertificateIds, Query, or CollectionId is required. The query fields supported for this endpoint are:
The following fields have been deprecated and may be removed in a future release; they will be honored if included in a request:
The following fields have been deprecated and may be removed in a future release; they will be ignored if included in a request:
Note: Queries may be done using either the primary field name or the field alias(es).
Tip: To exclude revoked certificates from the update, include a query of:
CertState -ne \"2\" To exclude expired certificates from the update, include a query of: ExpirationDate -ge \"%TODAY%\" |
CertificateIds |
Body |
Required in some cases. An array of integers indicating the Keyfactor Command certificate IDs to update. A value for one of CertificateIds, Query, or CollectionId is required. |
Metadata |
Body |
Required. An array of objects containing information about the metadata field(s) to update. For example: Copy
|
CollectionId | Query |
Required in some cases. 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:System-wide certificate permissionsGranular certificate permissionsUse 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. This field can also be used to specify the certificate collection containing certificates that should be updated. A value for one of CertificateIds, Query, or CollectionId is required. |



Was this page helpful? Provide Feedback