Venafi Metadata APIs API
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|
Venafi Metadata APIs API is one of 58 APIs that Venafi publishes on the 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.
This API exposes 17 operations across 17 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version 26.1.1.
Requests are made against 3 base URLs: /, https://REPLACEdnsnameME/, https://{dnsname}/.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Venafi Metadata APIs API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (AccessToken).
By default, every request must be authenticated.
Paths & Operations 17
Across 17 paths, the API surfaces 17 operations — 1 GET, 16 POST. Each is listed below with its method, path, parameters, and response codes.
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 Metada…
Schemas 36
The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are Core_WebSDK_MetadataWebResponse_readeffectivevalues (6 properties), Core_WebSDK_MetadataWebResponse_readpolicy (4 properties), Core_WebSDK_MetadataWebRequest_setpolicy (4 properties), Core_WebSDK_MetadataWebResponse_defineitem (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Venafi 12
Other APIs Venafi publishes across the network.
This is an independent, third-party profile of Venafi Metadata APIs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.