Method: projects.dlpJobs.list

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

HTTP request

GET https://dlp.googleapis.com/v2/{parent=projects/*}/dlpJobs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

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

  • dlp.jobs.list

Query parameters

Parameters
filter

string

Optional. Allows filtering.

Supported syntax:

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  • A restriction has the form of <field> <operator> <value>.
  • Supported fields/values for inspect jobs:
    • state - PENDING|RUNNING|CANCELED|FINISHED|FAILED
    • inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
    • trigger_name - The resource name of the trigger that created job.
  • Supported fields for risk analysis jobs:
    • state - RUNNING|CANCELED|FINISHED|FAILED
  • The operator must be = or !=.

Examples:

  • inspected_storage = cloud_storage AND state = done
  • inspected_storage = cloud_storage OR inspected_storage = bigquery
  • inspected_storage = cloud_storage AND (state = done OR state = canceled)

The length of this field should be no more than 500 characters.

pageSize

number

The standard list page size.

pageToken

string

The standard list page token.

type

enum(DlpJobType)

The type of job. Defaults to DlpJobType.INSPECT

orderBy

string

Optional comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant.

Example: name asc, endTime asc, createTime desc

Supported fields are:

  • createTime: corresponds to time the job was created.
  • endTime: corresponds to time the job ended.
  • name: corresponds to job's name.
  • state: corresponds to state

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

The response message for listing DLP jobs.

JSON representation
{
  "jobs": [
    {
      object(DlpJob)
    }
  ],
  "nextPageToken": string
}
Fields
jobs[]

object(DlpJob)

A list of DlpJobs that matches the specified filter in the request.

nextPageToken

string

The standard List next-page token.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Data Loss Prevention API