How to create CICD for Purview to deploy Components from lower Environment to higher Environment, and where is purview API Specification documentation ?

Question

How to create CICD for Purview to deploy Components from lower Environment to higher Environment, and where is purview API Specification documentation ?

Harn(Au) Thonglertwong 40

How to set up CI/CD for Microsoft Purview to deploy components across environments

I found an older article: 🔗 https://learn.microsoft.com/en-us/answers/questions/1631818/purview-cicd-process as well as documentation related to Purview Classic: 🔗 https://learn.microsoft.com/en-us/purview/legacy/deployment-best-practices#deployment-models

However, both references are outdated and focus on Classic Purview only.

I'm trying to understand whether the new Microsoft Purview (Unified Data Governance) currently supports CI/CD to deploy components from a lower environment to a higher one.

I understand that source scans must be re-registered manually in each environment. But what about other components like:

Descriptions added to data assets
Glossary terms (both Classic and New Purview)

Governance domains

CDEs, OKRs, and other catalog metadata?

Is there a way to automate the deployment of these items, so we don’t have to manually recreate everything across environments?

If native CI/CD is not supported yet, is there at least a reliable API-based workaround?

I’ve tried looking for Purview API documentation, but it’s quite limited. I only found for:

Datamap
Classic glossary term APIs
Classic Purview ... etc..

But I couldn’t find documentation for APIs related to Unified Purview components like:

Governance domains

Unified glossary terms

CDEs, OKRs

Where can I find the API documentation for these new catalog items?

In conclusion, I’m looking for answers to these three key questions:

1.What is the easiest and most efficient way to deploy Microsoft Purview components across environments (e.g., from non-prod to prod)?

2.Where is the official API specification for Classic Purview?

3.Where is the API specification for the new Unified Purview Catalog (including governance domains, unified glossary terms, CDEs, OKRs, etc.)?

0 comments

1 answer

Your answer

Answer 1

Smaran Thoomu 35,125 Microsoft External Staff Moderator

Hi Harn(Au) Thonglertwong

Thanks for your detailed question - you've captured the key gaps well, especially around CI/CD and Unified Purview APIs.

CI/CD for Microsoft Purview (Unified)

As of now, Microsoft Purview (Unified) does not support full native CI/CD for deploying catalog components like glossary terms, domains, or CDEs across environments. That said, here are the current options:

Manual Export/Import via REST APIs (where available)

Custom scripting using the REST APIs (PowerShell or Python)

Azure DevOps or GitHub Actions can be used to automate what’s possible via APIs

Unfortunately, scans, source registration, and RBAC assignments still need to be configured manually per environment.

Treat metadata like glossary terms or domain definitions as source-controlled JSON and use script-based promotion.

API Specification for Classic Purview

Classic Purview API documentation is available here:

Microsoft Purview REST API (Classic)

It includes:

Glossary APIs
Entity management
Classification/tagging

API Documentation for Unified Purview (Governance Portal)

Currently, documentation for Unified Purview (Governance Portal) APIs is partially released and not yet fully published for all components like:

Governance domains

CDEs (Critical Data Elements)

OKRs

Unified glossary terms

That said, you can track API availability and updates via:

If you're open to experimentation, the Microsoft Purview Studio > Developer Tools > REST API Tester sometimes exposes newer endpoints.

Suggested Action Plan

For components with available APIs (like classic glossary), export via REST and script the import
Monitor the Microsoft Purview roadmap for CI/CD enhancements
Consider submitting feedback via the Purview Studio feedback option to prioritize CI/CD support for metadata assets

I hope this information helps. Please do let us know if you have any further queries.

Kindly consider upvoting the comment if the information provided is helpful. This can assist other community members in resolving similar issues.

Harn(Au) Thonglertwong 40 Reputation points

2025-08-04T03:01:54.53+00:00
@Smaran Thoomu ,

Thanks for the response. So does this mean the new Purview API is still unavailable?

eg. for create update export these items,

Governance domains

Unified glossary terms

CDEs, OKRs
Smaran Thoomu 35,125 Reputation points Microsoft External Staff Moderator

2025-08-05T19:29:27.0133333+00:00
Harn(Au) Thonglertwong You're correct - as of now, official public APIs for Unified Purview components such as Governance Domains, Unified Glossary Terms, CDEs, and OKRs are not yet generally available.

Here’s a quick status summary:

Current API Availability:

Classic Glossary APIs – Available and documented

Datamap APIs (e.g., for assets, classifications) – Available

Unified Purview APIs (e.g., for Domains, Unified Glossary, CDEs) – Not yet publicly documented or supported for create/update/export operations

While some preview endpoints may appear through developer tools in Purview Studio (e.g., REST API Tester), these are not officially supported and subject to change.

What you can do:

Track roadmap updates: Unified Purview API coverage is expanding but remains incomplete. Keep an eye on Microsoft Purview documentation and Azure Updates.

Submit feedback: Use the feedback option in the Purview portal to emphasize the need for CI/CD and API support for metadata governance components.

Workaround: For now, teams are relying on custom export/import scripts for classic APIs and maintaining versioned JSON metadata files as a partial CI/CD approach.

I hope this information helps. Please do let us know if you have any further queries.

If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.
Harn(Au) Thonglertwong 40 Reputation points

2025-10-31T08:17:36.26+00:00

Hi @Smaran Thoomu,

I noticed that Microsoft has updated the Purview API to include Unified Catalog components: https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-api-overview

It appears that APIs to create/update the following are now available:

-Objectives and Key Results (OKRs)

-Business Domains

-Critical Data Elements

-Data Products

-Glossary Terms

-Data Access Policies

However, I haven’t been able to find the detailed API specifications (endpoints, request/response schemas, examples) for these features. Could you point me to the documentation or OpenAPI/Swagger specs for the Unified Catalog APIs?

Thank you

Share via

How to create CICD for Purview to deploy Components from lower Environment to higher Environment, and where is purview API Specification documentation ?

1 answer

Your answer