How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenMetadata Policies API

A `Policy` defines control that needs to be applied across different Data Entities.

OpenMetadata Policies API is one of 89 APIs that OpenMetadata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Policies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 17 operations across 11 paths, and defines 31 schemas. It is described by OpenAPI 3.0.1, at version 1.13.

Requests are made against 2 base URLs: /api, http://localhost:8585/api.

17 operations 11 paths 31 schemas 3 DELETE9 GET2 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.13
Base URL
https://{your-host}/api/v1
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

OpenMetadata Policies API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 17

Across 11 paths, the API surfaces 17 operations — 3 DELETE, 9 GET, 2 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Policies 17

A Policy defines control that needs to be applied across different Data Entities.

GET
/v1/policies
List policies
listPolicies 5 params → 200
PUT
/v1/policies
Create or update a policy
createOrUpdatePolicy body → 200400
POST
/v1/policies
Create a policy
createPolicy body → 200400
GET
/v1/policies/name/{fqn}
Get a policy by fully qualified name
getPolicyByFQN 4 params → 200404
DELETE
/v1/policies/name/{fqn}
Delete a policy by fully qualified name
deletePolicyByFQN 2 params → 200404
PATCH
/v1/policies/name/{fqn}
Update a policy by name.
patchPolicy 1 param body → default
GET
/v1/policies/{id}
Get a policy by id
getPolicyByID 4 params → 200404
DELETE
/v1/policies/{id}
Delete a policy by Id
deletePolicy 2 params → 200404
PATCH
/v1/policies/{id}
Update a policy
patchPolicy_1 1 param body → default
DELETE
/v1/policies/async/{id}
Asynchronously delete a policy by Id
deletePolicyAsync 2 params → 200404
GET
/v1/policies/{id}/versions/{version}
Get a version of the policy by Id
getSpecificPolicyVersion 2 params → 200404
GET
/v1/policies/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_36 5 params → 200
GET
/v1/policies/functions
Get list of policy functions used in authoring conditions in policy rules.
listPolicyFunctions → default
GET
/v1/policies/resources
Get list of policy resources used in authoring a policy
listPolicyResources → default
GET
/v1/policies/{id}/versions
List policy versions
listAllPolicyVersion 1 param → 200
PUT
/v1/policies/restore
Restore a soft deleted policy
restore_27 body → 200
GET
/v1/policies/validation/condition/{expression}
Validate a given condition
validateCondition 1 param → 204400

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are Policy (39 properties), TagLabel (13 properties), CreatePolicy (13 properties), EntityReference (9 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
ParamAdditionalContext
object
1 property
ResultListFunction
object
5 properties 1 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
RestoreEntity
object
1 property 1 required
CoverImage
object
2 properties
FieldChange
object
3 properties
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
ResultList
object
5 properties 1 required
CreatePolicy
object
13 properties 2 required
Paging
object
5 properties 1 required
JsonPatch
object
ChangeDescription
object
5 properties
ResourceDescriptor
object
2 properties
PolicyList
object
5 properties 1 required
UsageStats
object
2 properties 1 required
Function
object
6 properties
Style
object
3 properties
Votes
object
4 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
ResultListResourceDescriptor
object
5 properties 1 required
Policy
object
39 properties 3 required
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required
Rule
object
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-policies-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
OpenMetadata AI Applications API
OpenMetadata AI Governance Policies API
OpenMetadata API Collections API
OpenMetadata API Endpoint API
OpenMetadata API Services API
OpenMetadata Apps API
OpenMetadata Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
Where this information came from

This is an independent, third-party profile of OpenMetadata Policies 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.