# Venafi Metadata APIs API **Canonical:** https://apis.io/apis/venafi/venafi-metadata-apis-api/ **Provider:** Venafi — https://apis.io/providers/venafi/ **Base URL:** https://api.venafi.cloud **Documentation:** https://developer.venafi.com/tlsprotectcloud/reference/tls-protect-overview Venafi Metadata APIs API is one of 58 APIs that [Venafi](https://apis.io/providers/venafi/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Metadata APIs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation. The Metadata interface manages Custom Fields for objects that appear in the following places of the UI: * Certificates * Devices * Code Signing Projects * Code Signing Environments # Metadata Types |Type|Name|Description| |----|----|-----------| |1|Text|Can accept a single line of text. `MinimumLength`, `MaximumLength`, `Mask` and `RegularExpression` apply to this field type| |2|List|Provides the user with a list of selectable items. `Single` controls if one or more items can be selected| |3|Choice|Provides the user with options. if `Single` is **true**, the options are presented as radio-buttons, otherwise they are checkboxes| |4|Date|Provides the user with a date/time selector. `DateOnly` and `TimeOnly` apply to this field type| |5|Identity|Provides the user with the ability to select an identity. If `Single` is **true**, only one identity can be selected| # Metadata Item (Custom Field Definition) The Metadata Item describes a Custom Field. |Property name|Data Type|Description| |-------------|---------|-----------| |AllowedCharacters|string|_Optional_: All characters allowed in values| |AllowedValues|[string]|_Optional_: An array of allowable values| |Classes|[string]|An array of schema classes that can use the custom field| |SchemaAttribute|string|_Read-Only_: The Custom Field GUID| |DateOnly|boolean|_For Date type Custom Fields_: Only ask for date, hide time| |DN|string|_Read-Only_: The DN of the Custom Field definition object| |DefaultValues|[string]|_Optional_: An array of values used set by default on the CustomField| |Guid|string|_Read-Only_: The Custom Field GUID| |Help|string|_Optional_: The tool tip to show the user how to populate the Custom Field| |Label|string|The text that describes the Custom Field in the UI| |Mandatory|boolean|_Optional_: If **true**, users must enter a value for the Custom Field in the UI| |Mask|string|_Optional_: An input mask to use for Text type Custom Fields. The '#'-character represents characters the user may provide| |MaximumLength|nullable integer|_Optional_: The maximum number of characters a user can input for the Custom Field that accepts a string| |MinimumLength|nullable integer|_Optional_: The minimum number of characters a user must input for the Custom field that accepts a string| |Name|string|The name (CN) of the Custom Field. Required for `POST metadata/defineitem`, read-only otherwise| |Policyable|boolean|_Optional_: If **true**, policy will be applied to a Custom Field| |RegularExpression|string|_Optional_: The regular expression to apply to user input in a Text type Custom Field| |RenderHidden|boolean|_Optional_: If **true**, the UI will not display the Custom Field| |RenderReadOnly|boolean|_Optional_: If **true**, the UI will display the Custom Field but not let the user change it| |Single|boolean|_Optional_: If **true**, only a single value can be selected for a List or Choice type Custom Field| |TimeOnly|boolean|_Optional_: If **true**, only a time can be entered in a Date type Custom Field| |Type|integer|The type of the Custom Field. Required for `Post metadata/defineitem`, read-only otherwise| ## Operations (17) | Method | Path | Summary | |---|---|---| | POST | `/vedsdk/metadata/defineitem` | Create a Custom Field | | POST | `/vedsdk/metadata/updateitem` | Update a Custom Field | | POST | `/vedsdk/metadata/undefineitem` | Delete a Custom Field | | GET | `/vedsdk/metadata/items` | Get all Custom Fields | | POST | `/vedsdk/metadata/finditem` | Find a Custom Field | | POST | `/vedsdk/metadata/loaditem` | Get Custom Field definition | | POST | `/vedsdk/metadata/loaditemguid` | Get Custom Field GUID | | POST | `/vedsdk/metadata/get` | Read values | | POST | `/vedsdk/metadata/readeffectivevalues` | Read effective value | | POST | `/vedsdk/metadata/readpolicy` | Read policy value | | POST | `/vedsdk/metadata/set` | Write value | | POST | `/vedsdk/metadata/setpolicy` | Write policy value | | POST | `/vedsdk/metadata/find` | Search objects | | POST | `/vedsdk/metadata/getitems` | Get applicable Custom Fields | | POST | `/vedsdk/metadata/getitemguids` | Get applicable Custom Field GUIDs | | POST | `/vedsdk/metadata/getpolicyitems` | Get allowed Custom Fields | | POST | `/vedsdk/metadata/getitemsforclass` | Get Custom Fields for class | ## Machine-readable artifacts (4) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/venafi/refs/heads/main/openapi/venafi-metadata-apis-api-openapi.yml - **Documentation** — https://developer.venafi.com/tlsprotectcloud/reference/tls-protect-overview - **Webhooks** — https://raw.githubusercontent.com/api-evangelist/venafi/refs/heads/main/asyncapi/venafi-certificate-manager-saas-webhooks.yml - **Documentation** — https://docs.venafi.com/Docs/currentSDK/TopNav/Content/SDK/WebSDK/cco-sdk-GettingStarted.php ## Other Venafi APIs (12) - [Venafi Access Management APIs API](https://apis.io/apis/venafi/venafi-access-management-apis-api/) - [Venafi AlgorithmSelector APIs API](https://apis.io/apis/venafi/venafi-algorithmselector-apis-api/) - [Venafi Application API](https://apis.io/apis/venafi/venafi-application-api/) - [Venafi Authentication Server APIs API](https://apis.io/apis/venafi/venafi-authentication-server-apis-api/) - [Venafi Certificate Approvals API](https://apis.io/apis/venafi/venafi-certificate-approvals-api/) - [Venafi Certificate Auto-renewal Monitoring API](https://apis.io/apis/venafi/venafi-certificate-auto-renewal-monitoring-api/) - [Venafi Certificate Discovery API](https://apis.io/apis/venafi/venafi-certificate-discovery-api/) - [Venafi Certificate Expiration Reports API](https://apis.io/apis/venafi/venafi-certificate-expiration-reports-api/) - [Venafi Certificate Import API](https://apis.io/apis/venafi/venafi-certificate-import-api/) - [Venafi Certificate Installations API](https://apis.io/apis/venafi/venafi-certificate-installations-api/) - [Venafi Certificate Inventory Monitoring API](https://apis.io/apis/venafi/venafi-certificate-inventory-monitoring-api/) - [Venafi Certificate Management APIs API](https://apis.io/apis/venafi/venafi-certificate-management-apis-api/) ## Tags Metadata APIs --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/venafi/venafi-metadata-apis-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/venafi/.