Cloud Data Loss Prevention (Cloud DLP) is now a part of Sensitive Data Protection. The API name remains the same: Cloud Data Loss Prevention API (DLP API). For information about the services that make up Sensitive Data Protection, see Sensitive Data Protection overview.

Method: projects.image.redact

HTTP request
Path parameters
Request body
- JSON representation
Response body
Authorization scopes
Try it!

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more.

When no InfoTypes or CustomInfoTypes are specified in this request, 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

Choose a location:

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`parent`	`string` Parent resource name. The format of this value varies depending on whether you have specified a processing location: Projects scope, location specified: `projects/{projectId}/locations/{locationId}` Projects scope, no location specified (defaults to global): `projects/{projectId}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: `parent=projects/example-project/locations/europe-west3` Authorization requires the following IAM permission on the specified resource `parent`: `serviceusage.services.use`

parent

string

Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

Projects scope, location specified: projects/{projectId}/locations/{locationId}
Projects scope, no location specified (defaults to global): projects/{projectId}

The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

parent=projects/example-project/locations/europe-west3

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

serviceusage.services.use

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{ "locationId": string, "inspectConfig": { object (`InspectConfig`) }, "imageRedactionConfigs": [ { object (`ImageRedactionConfig`) } ], "includeFindings": boolean, "byteItem": { object (`ByteContentItem`) } }

{
  "locationId": string,
  "inspectConfig": {
    object (InspectConfig)
  },
  "imageRedactionConfigs": [
    {
      object (ImageRedactionConfig)
    }
  ],
  "includeFindings": boolean,
  "byteItem": {
    object (ByteContentItem)
  }
}

Fields
`locationId`	`string` Deprecated. This field has no effect.
`inspectConfig`	`object (InspectConfig)` Configuration for the inspector.
`imageRedactionConfigs[]`	`object (ImageRedactionConfig)` The configuration for specifying what content to redact from images.
`includeFindings`	`boolean` Whether the response should include findings along with the redacted image.
`byteItem`	`object (ByteContentItem)` The content must be PNG, JPEG, SVG or BMP.

Response body

If successful, the response body contains an instance of RedactImageResponse.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.