Runs an on-demand execution of a DataScan
HTTP request
POST https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/dataScans/*}:run
The URL uses gRPC Transcoding syntax.
Path parameters
name
string
Required. The resource name of the DataScan: projects/{project}/locations/{locationId}/dataScans/{dataScanId}
. where project
refers to a projectId
or project_number
and locationId
refers to a Google Cloud region.
Only OnDemanddata scans are allowed.
Authorization requires the following IAM
permission on the specified resource name
:
-
dataplex.datascans.run
Request body
The request body must be empty.
Response body
Run DataScan Response.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"job"
:
{
object (
|
| Fields | |
|---|---|
job
|
DataScanJob created by dataScans.run request. |
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .

