Method: projects.locations.dlpJobs.create

Creates a new job to inspect storage or calculate risk metrics. See and to learn more.

When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The parent resource name, for example projects/my-project-id.

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




The geographic location to store and process the job. Reserved for future extensions.

Request body

The request body contains data with the following structure:

JSON representation
  "jobId": string,

  // Union field job can be only one of the following:
  "inspectJob": {
    object (InspectJobConfig)
  "riskJob": {
    object (RiskAnalysisJobConfig)
  // End of list of possible types for union field job.


The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

Union field job. The configuration details for the specific type of job to run. job can be only one of the following:

object (InspectJobConfig)


object (RiskAnalysisJobConfig)

Response body

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

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

Try it!