How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Purview Scan Result API

Operations for running scans and viewing scan results

Microsoft Purview Scan Result API is one of 44 APIs that Microsoft Purview publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scan Result. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, pricing, a getting-started guide, and an API reference.

This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 2023-09-01.

Requests are made against a single base URL, https://{accountName}.scan.purview.azure.com.

3 operations 3 paths 3 schemas 1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-09-01
Base URL
https://{account-name}.purview.azure.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Microsoft Purview Scan Result API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

  • oauth2 — Azure Active Directory OAuth2 authentication

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Scan Result 3

Operations for running scans and viewing scan results

PUT
/scan/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}
Microsoft Purview Run a scan
runScan 5 params → 202401
POST
/scan/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}/:cancel
Microsoft Purview Cancel a scan run
cancelScan 4 params → 202401
GET
/scan/datasources/{dataSourceName}/scans/{scanName}/runs
Microsoft Purview List scan history
listScanHistory 3 params → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ScanResult (13 properties), ScanResultList (3 properties), OperationResponse (2 properties). Each schema is shown below with its type and property counts.

ScanResultList
object
3 properties
OperationResponse
object
2 properties
ScanResult
object
The result of a scan run
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-purview-scan-result-api-openapi.yml Raw ↑

Other APIs Microsoft Purview publishes across the network.

Microsoft Purview Accounts API
Microsoft Purview Approval API
Microsoft Purview Business Domains API
Microsoft Purview Cases API
Microsoft Purview Classification Rules API
Microsoft Purview Critical Data Elements API
Microsoft Purview Custodians API
Microsoft Purview Data Products API
Microsoft Purview Data Profiling API
Microsoft Purview Data Quality Rules API
Microsoft Purview Data Quality Scans API
Microsoft Purview Data Quality Scores API
Where this information came from

This is an independent, third-party profile of Microsoft Purview Scan Result API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.