Venafi

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|

GitHub OpenAPI

Operations 17

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 #

Documentation

📖
Documentation
https://developer.venafi.com/tlsprotectcloud/reference/tls-protect-overview
📖
Documentation
https://docs.venafi.com/Docs/currentSDK/TopNav/Content/SDK/WebSDK/cco-sdk-GettingStarted.php

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/venafi/refs/heads/main/openapi/venafi-metadata-apis-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/venafi/refs/heads/main/asyncapi/venafi-certificate-manager-saas-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/venafi-metadata-apis-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

venafi-metadata-apis-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Trust Protection Foundation WebSDK Metadata APIs API
  description: '# Introduction

    The Trust Protection Foundation Web SDK is a subset of REST APIs that allow you to:

    * Automate certificate management

    * Integrate with DevOps processes

    * Discover machine identities

    * Extract data to integrate with data warehouses

    * Perform bulk actions

    * Set up and administer Trust Protection Foundation

    * Onboard teams

    * Create custom, automated business logic and flows between internal systems


    All these use cases can be accomplished using the Trust Protection Foundation REST…'
  version: 26.1.1
servers:
- url: /
  description: Current Host
- url: https://REPLACEdnsnameME/
  description: System
- url: https://{dnsname}/
  description: Configurable Hostname
  variables:
    dnsname:
      default: localhost
      description: Production API Hostname
security:
- AccessToken: []
tags:


# --- truncated at 32 KB (90 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/venafi/refs/heads/main/openapi/venafi-metadata-apis-api-openapi.yml