Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/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
POST https://dlp.googleapis.com/v2/{parent=projects/*}/image:redact
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
The parent resource name, for example projects/my-project-id. Authorization requires the following Google IAM permission on the specified resource
|
Request body
The request body contains data with the following structure:
JSON representation | |
---|---|
{ "locationId": string, "inspectConfig": { object ( |
Fields | |
---|---|
locationId |
The geographic location to process the request. Reserved for future extensions. |
inspectConfig |
Configuration for the inspector. |
imageRedactionConfigs[] |
The configuration for specifying what content to redact from images. |
includeFindings |
Whether the response should include findings along with the redacted image. |
byteItem |
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.