Microsoft Purview

Microsoft Purview Lineage API

Operations for tracking data lineage

GitHub OpenAPI

Operations 3

GET /api/atlas/v2/lineage/{guid} Microsoft Purview Get lineage by GUID #
GET /api/atlas/v2/lineage/{guid}/next Microsoft Purview Get next page of lineage #
GET /api/atlas/v2/lineage/uniqueAttribute/type/{typeName} Microsoft Purview Get lineage by unique attribute #

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-lineage-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-lineage-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-lineage-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Microsoft Purview Lineage 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 Lineage 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: Lineage
  description: Operations for tracking data lineage
paths:
  /api/atlas/v2/lineage/{guid}:
    get:
      operationId: getLineageByGuid
      summary: Microsoft Purview Get lineage by GUID
      description: Get lineage info of the entity specified by GUID.
      tags:
      - Lineage
      parameters:
      - name: guid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: direction
        in: query
        required: true
        description: The direction of lineage (INPUT, OUTPUT, BOTH)
        schema:
          type: string
          enum:
          - INPUT
          - OUTPUT
          - BOTH
      - name: depth
        in: query
        description: The number of hops for lineage
        schema:
          type: integer
          format: int32
          default: 3
      responses:
        '200':
          description: Lineage info retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasLineageInfo'
        '401':
          description: Unauthorized
        '404':
          description: Entity not found
    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/atlas/v2/lineage/{guid}/next:
    get:
      operationId: getLineageNextPage
      summary: Microsoft Purview Get next page of lineage
      description: Return immediate next page lineage info about entity with pagination.
      tags:
      - Lineage
      parameters:
      - name: guid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: direction
        in: query
        required: true
        schema:
          type: string
          enum:
          - INPUT
          - OUTPUT
          - BOTH
      - name: offset
        in: query
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Next page of lineage retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasLineageInfo'
        '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/atlas/v2/lineage/uniqueAttribute/type/{typeName}:
    get:
      operationId: lineageGetByUniqueAttribute
      summary: Microsoft Purview Get lineage by unique attribute
      description: Return lineage info about entity. In addition to the typeName path parameter, attribute key-value pair(s) can be provided.
      tags:
      - Lineage
      parameters:
      - name: typeName
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: '2023-09-01'
      - name: direction
        in: query
        required: true
        schema:
          type: string
          enum:
          - INPUT
          - OUTPUT
          - BOTH
      - name: depth
        in: query
        schema:
          type: integer
          format: int32
          default: 3
      responses:
        '200':
          description: Lineage info retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasLineageInfo_2'
        '401':
          description: Unauthorized
    servers:
    - 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
components:
  schemas:
    AtlasTermAssignmentHeader:
      type: object
      properties:
        confidence:
          type: integer
          format: int32
        createdBy:
          type: string
        description:
          type: string
        displayText:
          type: string
        expression:
          type: string
        relationGuid:
          type: string
          format: uuid
        status:
          type: string
          enum:
          - DISCOVERED
          - PROPOSED
          - IMPORTED
          - VALIDATED
          - DEPRECATED
          - OBSOLETE
          - OTHER
        steward:
          type: string
        termGuid:
          type: string
          format: uuid
    ParentRelation:
      type: object
      properties:
        childEntityId:
          type: string
          format: uuid
        parentEntityId:
          type: string
          format: uuid
        relationshipId:
          type: string
          format: uuid
    AtlasLineageInfo:
      type: object
      description: Lineage information for an entity
      properties:
        baseEntityGuid:
          type: string
          format: uuid
        childrenCount:
          type: integer
          format: int32
        guidEntityMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AtlasEntityHeader'
        lineageDepth:
          type: integer
          format: int32
        lineageDirection:
          type: string
          enum:
          - INPUT
          - OUTPUT
          - BOTH
        lineageWidth:
          type: integer
          format: int32
        parentRelations:
          type: array
          items:
            $ref: '#/components/schemas/ParentRelation'
        relations:
          type: array
          items:
            $ref: '#/components/schemas/LineageRelation'
    TimeBoundary:
      type: object
      properties:
        endTime:
          type: string
        startTime:
          type: string
        timeZone:
          type: string
    LineageRelation:
      type: object
      properties:
        fromEntityId:
          type: string
          format: uuid
        relationshipId:
          type: string
          format: uuid
        toEntityId:
          type: string
          format: uuid
    AtlasEntityHeader:
      type: object
      description: An instance of an entity header
      properties:
        attributes:
          type: object
          additionalProperties: true
        typeName:
          type: string
        lastModifiedTS:
          type: string
        classificationNames:
          type: array
          items:
            type: string
        classifications:
          type: array
          items:
            $ref: '#/components/schemas/AtlasClassification'
        displayText:
          type: string
        guid:
          type: string
          format: uuid
        labels:
          type: array
          items:
            type: string
        meaningNames:
          type: array
          items:
            type: string
        meanings:
          type: array
          items:
            $ref: '#/components/schemas/AtlasTermAssignmentHeader'
        status:
          type: string
          enum:
          - ACTIVE
          - DELETED
    AtlasClassification:
      type: object
      description: A classification instance
      properties:
        attributes:
          type: object
          additionalProperties: true
        typeName:
          type: string
        lastModifiedTS:
          type: string
        entityGuid:
          type: string
          format: uuid
        entityStatus:
          type: string
          enum:
          - ACTIVE
          - DELETED
        propagate:
          type: boolean
        removePropagationsOnEntityDelete:
          type: boolean
        validityPeriods:
          type: array
          items:
            $ref: '#/components/schemas/TimeBoundary'
    AtlasLineageInfo_2:
      type: object
      properties:
        baseEntityGuid:
          type: string
          format: uuid
        guidEntityMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AtlasEntityHeader_2'
        lineageDepth:
          type: integer
          format: int32
        lineageDirection:
          type: string
          enum:
          - INPUT
          - OUTPUT
          - BOTH
        relations:
          type: array
          items:
            $ref: '#/components/schemas/LineageRelation'
    AtlasEntityHeader_2:
      type: object
      properties:
        attributes:
          type: object
          additionalProperties: true
        typeName:
          type: string
        classificationNames:
          type: array
          items:
            type: string
        displayText:
          type: string
        guid:
          type: string
          format: uuid
        labels:
          type: array
          items:
            type: string
        status:
          type: string
          enum:
          - ACTIVE
          - DELETED
  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