Microsoft Purview Scan Rulesets API

Operations for managing scan rulesets

Documentation 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/scanrulesets/{scanRulesetName} Create or replace a scan rule set · Microsoft Purview Create or replace a scan ruleset #

Ask an LLM

“How do I create a custom scan rule set?”

“Can I overwrite an existing scan rule set's properties?”

Tell an agent

Create scan rule set {ruleset} of kind {kind}.

Replace scan ruleset {ruleset} with properties {props}.

GET /scan/scanrulesets/{scanRulesetName} Get a scan rule set · Microsoft Purview Get a scan ruleset #

Ask an LLM

“Which file types and classifications does a scan rule set include?”

“Can I see one scan rule set by name?”

Tell an agent

Show me scan rule set {ruleset}.

Get the definition of scan ruleset {ruleset}.

DELETE /scan/scanrulesets/{scanRulesetName} Delete a scan rule set · Microsoft Purview Delete a scan ruleset #

Ask an LLM

“Can I delete a custom scan rule set?”

“What is the way to remove an unused scan ruleset?”

Tell an agent destructive · confirm first

Delete scan rule set {ruleset}.

Remove the {ruleset} scan ruleset.

GET /scan/scanrulesets List scan rule sets · Microsoft Purview List scan rulesets #

Ask an LLM

“Which scan rule sets are available in my account?”

“What custom rule sets can my scans use?”

Tell an agent

List all scan rule sets.

List scan rulesets using API version {version}.

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:microsoft-purview-scan-rulesets-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

openapi: 3.2.0
info:
  title: Microsoft Purview Scanning Scan Rulesets 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: Scan Rulesets
  description: Operations for managing scan rulesets
paths:
  /scan/scanrulesets/{scanRulesetName}:
    put:
      operationId: createOrReplaceScanRuleset
      summary: Microsoft Purview Create or replace a scan ruleset
      description: Creates or replaces a scan ruleset.
      tags:
      - Scan Rulesets
      parameters:
      - name: scanRulesetName
        in: path
        required: true
        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/ScanRuleset'
      responses:
        '200':
          description: Scan ruleset updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanRuleset'
        '201':
          description: Scan ruleset created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanRuleset'
        '401':
          description: Unauthorized
    get:
      operationId: getScanRuleset
      summary: Microsoft Purview Get a scan ruleset
      description: Gets a scan ruleset by name.
      tags:
      - Scan Rulesets
      parameters:
      - name: scanRulesetName
        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 ruleset retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanRuleset'
        '401':
          description: Unauthorized
        '404':
          description: Scan ruleset not found
    delete:
      operationId: deleteScanRuleset
      summary: Microsoft Purview Delete a scan ruleset
      description: Deletes a scan ruleset.
      tags:
      - Scan Rulesets
      parameters:
      - name: scanRulesetName
        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 ruleset deleted successfully
        '401':
          description: Unauthorized
  /scan/scanrulesets:
    get:
      operationId: listScanRulesets
      summary: Microsoft Purview List scan rulesets
      description: Lists scan rulesets in the account.
      tags:
      - Scan Rulesets
      parameters:
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: '2023-09-01'
      responses:
        '200':
          description: Scan rulesets listed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanRulesetList'
        '401':
          description: Unauthorized
components:
  schemas:
    ScanRulesetList:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ScanRuleset'
        nextLink:
          type: string
        count:
          type: integer
          format: int64
    ScanRuleset:
      type: object
      description: A scan ruleset configuration
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
        kind:
          type: string
        properties:
          type: object
          properties:
            description:
              type: string
            includedCustomClassificationRuleNames:
              type: array
              items:
                type: string
            createdAt:
              type: string
              format: date-time
            lastModifiedAt:
              type: string
              format: date-time
  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

Microsoft Purview Scan Rulesets API

Operations 4

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification