Method: projects.locations.dataScans.create

Creates a DataScan resource.

HTTP request

POST https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/dataScans

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the parent location: projects/{project}/locations/{locationId} where project refers to a projectId or project_number and locationId refers to a GCP region.

Authorization requires the following IAM permission on the specified resource parent:

  • dataplex.datascans.create

Query parameters

Parameters
dataScanId

string

Required. DataScan identifier.

  • Must contain only lowercase letters, numbers and hyphens.
  • Must start with a letter.
  • Must end with a number or a letter.
  • Must be between 1-63 characters.
  • Must be unique within the customer project / location.
validateOnly

boolean

Optional. Only validate the request, but do not perform mutations. The default is false.

Request body

The request body contains an instance of DataScan.

Response body

If successful, the response body contains a newly created instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.