Microsoft Purview

Microsoft Purview Discovery API

Operations for searching and discovering data assets

GitHub OpenAPI

Operations 3

POST /api/search/query Microsoft Purview Search data assets #
POST /api/search/suggest Microsoft Purview Get search suggestions #
POST /api/search/autocomplete Microsoft Purview Get auto complete options #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/
📖
Authentication
https://learn.microsoft.com/en-us/purview/tutorial-using-rest-apis
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/data-gov-api-create-assets
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/scanning
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/account
📖
Authentication
https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/datamap
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/how-to-purview-custom-lineage-api-user-guide
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/metadatapolicies
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/tutorial-metadata-policy-collections-apis
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/workflow
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-api-overview
📖
Authentication
https://learn.microsoft.com/en-us/purview/data-gov-api-rest-data-plane
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-data-quality
📖
Documentation
https://learn.microsoft.com/en-us/graph/api/resources/security-ediscovery-apioverview?view=graph-rest-1.0
📖
Authentication
https://learn.microsoft.com/en-us/graph/security-ediscovery-appauthsetup
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/edisc-ref-api-guide
📖
Documentation
https://learn.microsoft.com/en-us/graph/security-information-protection-overview
📖
Documentation
https://learn.microsoft.com/en-us/graph/security-datasecurityandgovernance-overview
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/developer/use-the-api
📖
Documentation
https://learn.microsoft.com/en-us/graph/api/resources/security-recordsmanagement-overview?view=graph-rest-1.0

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/microsoft-purview/refs/heads/main/openapi/microsoft-purview-discovery-api-openapi.yml

Other Resources

🔗
Pricing
https://azure.microsoft.com/en-us/pricing/details/purview/
🔗
Reference
https://learn.microsoft.com/en-us/purview/data-map-data-sources
🔗
Reference
https://learn.microsoft.com/en-us/purview/unified-catalog-data-quality
🔗
Reference
https://learn.microsoft.com/en-us/purview/sensitivity-labels
🔗
Reference
https://learn.microsoft.com/en-us/purview/developer/
🔗
Reference
https://learn.microsoft.com/en-us/graph/compliance-concept-overview

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/microsoft-purview-discovery-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

microsoft-purview-discovery-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Microsoft Purview Discovery API
  contact:
    name: Microsoft Purview Support
    url: https://learn.microsoft.com/en-us/purview/
  license:
    name: Microsoft API License
    url: https://azure.microsoft.com/en-us/support/legal/
  version: '1.0'
  description: 'Operations tagged Discovery across 2 of this provider''s published API definitions: microsoft-purview-catalog-openapi.yml, microsoft-purview-data-map-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{accountName}.purview.azure.com/catalog
  description: Microsoft Purview Catalog API endpoint
  variables:
    accountName:
      description: The name of the Microsoft Purview account
      default: myaccount
- url: https://{accountName}.purview.azure.com/datamap
  description: Microsoft Purview Data Map API endpoint
  variables:
    accountName:
      description: The name of the Microsoft Purview account
      default: myaccount
security:
- oauth2: []
tags:
- name: Discovery
  description: Operations for searching and discovering data assets
paths:
  /api/search/query:
    post:
      operationId: searchQuery
      summary: Microsoft Purview Search data assets
      description: Get data using search.
      tags:
      - Discovery
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
      responses:
        '200':
          description: Search results retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResult'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
    servers:
    - url: https://{accountName}.purview.azure.com/catalog
      description: Microsoft Purview Catalog API endpoint
      variables:
        accountName:
          description: The name of the Microsoft Purview account
          default: myaccount
  /api/search/suggest:
    post:
      operationId: searchSuggest
      summary: Microsoft Purview Get search suggestions
      description: Get search suggestions by query criteria.
      tags:
      - Discovery
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuggestRequest'
      responses:
        '200':
          description: Suggestions retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuggestResult'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
    servers:
    - url: https://{accountName}.purview.azure.com/catalog
      description: Microsoft Purview Catalog API endpoint
      variables:
        accountName:
          description: The name of the Microsoft Purview account
          default: myaccount
  /api/search/autocomplete:
    post:
      operationId: searchAutoComplete
      summary: Microsoft Purview Get auto complete options
      description: Get auto complete options for search.
      tags:
      - Discovery
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutoCompleteRequest'
      responses:
        '200':
          description: Auto complete results retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoCompleteResult'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
    servers:
    - url: https://{accountName}.purview.azure.com/catalog
      description: Microsoft Purview Catalog API endpoint
      variables:
        accountName:
          description: The name of the Microsoft Purview account
          default: myaccount
components:
  schemas:
    SuggestRequest:
      type: object
      properties:
        keywords:
          type: string
        limit:
          type: integer
          format: int32
        filter:
          type: object
    AutoCompleteResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/AutoCompleteResultValue'
    SearchResultValue:
      type: object
      properties:
        searchScore:
          type: number
          format: float
        searchHighlights:
          type: object
        objectType:
          type: string
        createTime:
          type: integer
          format: int64
        updateTime:
          type: integer
          format: int64
        id:
          type: string
        name:
          type: string
        qualifiedName:
          type: string
        entityType:
          type: string
        description:
          type: string
        classification:
          type: array
          items:
            type: string
        label:
          type: array
          items:
            type: string
        term:
          type: array
          items:
            $ref: '#/components/schemas/TermSearchResultValue'
        owner:
          type: string
        assetType:
          type: array
          items:
            type: string
    SuggestResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/SearchResultValue'
    AutoCompleteResultValue:
      type: object
      properties:
        text:
          type: string
        queryPlusText:
          type: string
    SearchRequest:
      type: object
      description: Search request payload
      properties:
        keywords:
          type: string
        offset:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        filter:
          type: object
        facets:
          type: array
          items:
            $ref: '#/components/schemas/SearchFacetItem'
        taxonomySetting:
          type: object
    SearchResult:
      type: object
      description: Search result
      properties:
        searchCount:
          type: integer
          format: int32
        searchFacets:
          type: object
        value:
          type: array
          items:
            $ref: '#/components/schemas/SearchResultValue'
    AutoCompleteRequest:
      type: object
      properties:
        keywords:
          type: string
        limit:
          type: integer
          format: int32
        filter:
          type: object
    TermSearchResultValue:
      type: object
      properties:
        name:
          type: string
        glossaryName:
          type: string
        guid:
          type: string
          format: uuid
    SearchFacetItem:
      type: object
      properties:
        count:
          type: integer
          format: int32
        facet:
          type: string
        sort:
          type: object
    AutoCompleteResult_2:
      type: object
      properties:
        value:
          type: array
          items:
            type: object
            properties:
              text:
                type: string
              queryPlusText:
                type: string
    SuggestResult_2:
      type: object
      properties:
        value:
          type: array
          items:
            type: object
    SearchRequest_2:
      type: object
      properties:
        keywords:
          type: string
        offset:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        filter:
          type: object
        facets:
          type: array
          items:
            type: object
    SearchResult_2:
      type: object
      properties:
        searchCount:
          type: integer
          format: int32
        searchFacets:
          type: object
        value:
          type: array
          items:
            type: object
  securitySchemes:
    oauth2:
      type: oauth2
      description: Azure Active Directory OAuth2 authentication
      flows:
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
          scopes:
            https://purview.azure.net/.default: Access Microsoft Purview
x-refined-from:
- microsoft-purview-catalog-openapi.yml
- microsoft-purview-data-map-openapi.yml