Microsoft Purview

Microsoft Purview Scans API

Operations for managing scan configurations

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

PUT /scan/datasources/{dataSourceName}/scans/{scanName} Create or replace a scan · Microsoft Purview Create or replace a scan #
Ask an LLM
“How do I set up a new scan for a registered data source?”
“Can I overwrite an existing scan's settings?”
Tell an agent
Create scan {scan} of kind {kind} on data source {source}.
Replace scan {scan} on {source} with properties {props}.
GET /scan/datasources/{dataSourceName}/scans/{scanName} Get a scan definition · Microsoft Purview Get a scan #
Ask an LLM
“How is a particular scan of a data source configured?”
“Which rule set does one scan use?”
Tell an agent
Show me scan {scan} on data source {source}.
Get the configuration of scan {scan} for {source}.
DELETE /scan/datasources/{dataSourceName}/scans/{scanName} Delete a scan · Microsoft Purview Delete a scan #
Ask an LLM
“Can I delete a scan from a data source?”
“What is the way to remove a scan definition?”
Tell an agent destructive · confirm first
Delete scan {scan} from data source {source}.
Remove the {scan} scan on {source}.
GET /scan/datasources/{dataSourceName}/scans List scans on a data source · Microsoft Purview List scans by data source #
Ask an LLM
“What scans are configured for a given data source?”
“Which scans exist under one registered source?”
Tell an agent
List the scans on data source {source}.
Show every scan defined for {source}.

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-scans-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-scans-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-scans-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Microsoft Purview Scanning Scans API
  description: APIs for configuring and managing scans of data sources to automatically discover and catalog data assets. Supports registering data sources and scheduling automated scans across your data estate.
  version: 2023-09-01
  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/
servers:
- url: https://{accountName}.scan.purview.azure.com
  description: Microsoft Purview Scanning API endpoint
  variables:
    accountName:
      description: The name of the Microsoft Purview account
      default: myaccount
security:
- oauth2: []
tags:
- name: Scans
  description: Operations for managing scan configurations
paths:
  /scan/datasources/{dataSourceName}/scans/{scanName}:
    put:
      operationId: createOrReplaceScan
      summary: Microsoft Purview Create or replace a scan
      description: Creates or replaces an instance of a scan for a given data source.
      tags:
      - Scans
      parameters:
      - name: dataSourceName
        in: path
        required: true
        description: The name of the data source
        schema:
          type: string
      - name: scanName
        in: path
        required: true
        description: The name of the scan
        schema:
          type: string
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: '2023-09-01'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Scan'
      responses:
        '200':
          description: Scan updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scan'
        '201':
          description: Scan created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scan'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
    get:
      operationId: getScan
      summary: Microsoft Purview Get a scan
      description: Gets a scan information for a given data source.
      tags:
      - Scans
      parameters:
      - name: dataSourceName
        in: path
        required: true
        schema:
          type: string
      - name: scanName
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: '2023-09-01'
      responses:
        '200':
          description: Scan retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scan'
        '401':
          description: Unauthorized
        '404':
          description: Scan not found
    delete:
      operationId: deleteScan
      summary: Microsoft Purview Delete a scan
      description: Deletes the scan associated with the data source.
      tags:
      - Scans
      parameters:
      - name: dataSourceName
        in: path
        required: true
        schema:
          type: string
      - name: scanName
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: '2023-09-01'
      responses:
        '200':
          description: Scan deleted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scan'
        '401':
          description: Unauthorized
        '404':
          description: Scan not found
  /scan/datasources/{dataSourceName}/scans:
    get:
      operationId: listScansByDataSource
      summary: Microsoft Purview List scans by data source
      description: Lists scans in a data source.
      tags:
      - Scans
      parameters:
      - name: dataSourceName
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: '2023-09-01'
      responses:
        '200':
          description: Scans listed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanList'
        '401':
          description: Unauthorized
components:
  schemas:
    ScanList:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Scan'
        nextLink:
          type: string
        count:
          type: integer
          format: int64
    Scan:
      type: object
      description: A scan configuration
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
        kind:
          type: string
          description: The scan type
        properties:
          type: object
          properties:
            scanRulesetName:
              type: string
            scanRulesetType:
              type: string
              enum:
              - Custom
              - System
            collection:
              $ref: '#/components/schemas/CollectionReference'
            connectedVia:
              $ref: '#/components/schemas/ConnectedVia'
            createdAt:
              type: string
              format: date-time
            lastModifiedAt:
              type: string
              format: date-time
            lastScheduled:
              type: string
              format: date-time
    CollectionReference:
      type: object
      properties:
        referenceName:
          type: string
        type:
          type: string
    ConnectedVia:
      type: object
      properties:
        referenceName:
          type: string
        integrationRuntimeType:
          type: string
  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