Provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories. The Cloud Data Loss Prevention API (DLP API) is part of Sensitive Data Protection .
- REST Resource: v2.infoTypes
- REST Resource: v2.locations.infoTypes
- REST Resource: v2.organizations.locations.columnDataProfiles
- REST Resource: v2.organizations.locations.connections
- REST Resource: v2.organizations.locations.discoveryConfigs
- REST Resource: v2.organizations.locations.fileStoreDataProfiles
- REST Resource: v2.organizations.locations.projectDataProfiles
- REST Resource: v2.organizations.locations.tableDataProfiles
- REST Resource: v2.projects.content
- REST Resource: v2.projects.deidentifyTemplates
- REST Resource: v2.projects.dlpJobs
- REST Resource: v2.projects.image
- REST Resource: v2.projects.inspectTemplates
- REST Resource: v2.projects.jobTriggers
- REST Resource: v2.projects.locations.columnDataProfiles
- REST Resource: v2.projects.locations.connections
- REST Resource: v2.projects.locations.content
- REST Resource: v2.projects.locations.deidentifyTemplates
- REST Resource: v2.projects.locations.discoveryConfigs
- REST Resource: v2.projects.locations.dlpJobs
- REST Resource: v2.projects.locations.fileStoreDataProfiles
- REST Resource: v2.projects.locations.image
- REST Resource: v2.projects.locations.inspectTemplates
- REST Resource: v2.projects.locations.jobTriggers
- REST Resource: v2.projects.locations.projectDataProfiles
- REST Resource: v2.projects.locations.storedInfoTypes
- REST Resource: v2.projects.locations.tableDataProfiles
- REST Resource: v2.projects.storedInfoTypes
Service: dlp.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries . If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
-
https://dlp.googleapis.com
Regional service endpoint
A regional service endpoint is a base URL that specifies the network address of an API service in a single region. A service that is available in multiple regions might have multiple regional endpoints. Select a location to see its regional service endpoint for this service.
REST Resource: v2.infoTypes
Methods | |
---|---|
list
|
GET /v2/infoTypes
Returns a list of the sensitive information types that the DLP API supports. |
REST Resource: v2.locations.infoTypes
Methods | |
---|---|
list
|
GET /v2/{parent=locations/*}/infoTypes
Returns a list of the sensitive information types that the DLP API supports. |
REST Resource: v2.organizations.locations.columnDataProfiles
Methods | |
---|---|
get
|
GET /v2/{name=organizations/*/locations/*/columnDataProfiles/*}
Gets a column data profile. |
list
|
GET /v2/{parent=organizations/*/locations/*}/columnDataProfiles
Lists column data profiles for an organization. |
REST Resource: v2.organizations.locations.connections
Methods | |
---|---|
create
|
POST /v2/{parent=organizations/*/locations/*}/connections
Create a Connection to an external data source. |
delete
|
DELETE /v2/{name=organizations/*/locations/*/connections/*}
Delete a Connection. |
get
|
GET /v2/{name=organizations/*/locations/*/connections/*}
Get a Connection by name. |
list
|
GET /v2/{parent=organizations/*/locations/*}/connections
Lists Connections in a parent. |
patch
|
PATCH /v2/{name=organizations/*/locations/*/connections/*}
Update a Connection. |
search
|
GET /v2/{parent=organizations/*/locations/*}/connections:search
Searches for Connections in a parent. |
REST Resource: v2.organizations.locations.discoveryConfigs
Methods | |
---|---|
create
|
POST /v2/{parent=organizations/*/locations/*}/discoveryConfigs
Creates a config for discovery to scan and profile storage. |
delete
|
DELETE /v2/{name=organizations/*/locations/*/discoveryConfigs/*}
Deletes a discovery configuration. |
get
|
GET /v2/{name=organizations/*/locations/*/discoveryConfigs/*}
Gets a discovery configuration. |
list
|
GET /v2/{parent=organizations/*/locations/*}/discoveryConfigs
Lists discovery configurations. |
patch
|
PATCH /v2/{name=organizations/*/locations/*/discoveryConfigs/*}
Updates a discovery configuration. |
REST Resource: v2.organizations.locations.fileStoreDataProfiles
Methods | |
---|---|
delete
|
DELETE /v2/{name=organizations/*/locations/*/fileStoreDataProfiles/*}
Delete a FileStoreDataProfile. |
get
|
GET /v2/{name=organizations/*/locations/*/fileStoreDataProfiles/*}
Gets a file store data profile. |
list
|
GET /v2/{parent=organizations/*/locations/*}/fileStoreDataProfiles
Lists file store data profiles for an organization. |
REST Resource: v2.organizations.locations.projectDataProfiles
Methods | |
---|---|
get
|
GET /v2/{name=organizations/*/locations/*/projectDataProfiles/*}
Gets a project data profile. |
list
|
GET /v2/{parent=organizations/*/locations/*}/projectDataProfiles
Lists project data profiles for an organization. |
REST Resource: v2.organizations.locations.tableDataProfiles
Methods | |
---|---|
delete
|
DELETE /v2/{name=organizations/*/locations/*/tableDataProfiles/*}
Delete a TableDataProfile. |
get
|
GET /v2/{name=organizations/*/locations/*/tableDataProfiles/*}
Gets a table data profile. |
list
|
GET /v2/{parent=organizations/*/locations/*}/tableDataProfiles
Lists table data profiles for an organization. |
REST Resource: v2.projects.content
Methods | |
---|---|
deidentify
|
POST /v2/{parent=projects/*}/content:deidentify
De-identifies potentially sensitive info from a ContentItem. |
inspect
|
POST /v2/{parent=projects/*}/content:inspect
Finds potentially sensitive info in content. |
reidentify
|
POST /v2/{parent=projects/*}/content:reidentify
Re-identifies content that has been de-identified. |
REST Resource: v2.projects.deidentifyTemplates
Methods | |
---|---|
create
|
POST /v2/{parent=projects/*}/deidentifyTemplates
Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. |
delete
|
DELETE /v2/{name=projects/*/deidentifyTemplates/*}
Deletes a DeidentifyTemplate. |
get
|
GET /v2/{name=projects/*/deidentifyTemplates/*}
Gets a DeidentifyTemplate. |
list
|
GET /v2/{parent=projects/*}/deidentifyTemplates
Lists DeidentifyTemplates. |
patch
|
PATCH /v2/{name=projects/*/deidentifyTemplates/*}
Updates the DeidentifyTemplate. |
REST Resource: v2.projects.dlpJobs
Methods | |
---|---|
cancel
|
POST /v2/{name=projects/*/dlpJobs/*}:cancel
Starts asynchronous cancellation on a long-running DlpJob. |
create
|
POST /v2/{parent=projects/*}/dlpJobs
Creates a new job to inspect storage or calculate risk metrics. |
delete
|
DELETE /v2/{name=projects/*/dlpJobs/*}
Deletes a long-running DlpJob. |
get
|
GET /v2/{name=projects/*/dlpJobs/*}
Gets the latest state of a long-running DlpJob. |
list
|
GET /v2/{parent=projects/*}/dlpJobs
Lists DlpJobs that match the specified filter in the request. |
REST Resource: v2.projects.image
Methods | |
---|---|
redact
|
POST /v2/{parent=projects/*}/image:redact
Redacts potentially sensitive info from an image. |
REST Resource: v2.projects.inspectTemplates
Methods | |
---|---|
create
|
POST /v2/{parent=projects/*}/inspectTemplates
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. |
delete
|
DELETE /v2/{name=projects/*/inspectTemplates/*}
Deletes an InspectTemplate. |
get
|
GET /v2/{name=projects/*/inspectTemplates/*}
Gets an InspectTemplate. |
list
|
GET /v2/{parent=projects/*}/inspectTemplates
Lists InspectTemplates. |
patch
|
PATCH /v2/{name=projects/*/inspectTemplates/*}
Updates the InspectTemplate. |
REST Resource: v2.projects.jobTriggers
Methods | |
---|---|
activate
|
POST /v2/{name=projects/*/jobTriggers/*}:activate
Activate a job trigger. |
create
|
POST /v2/{parent=projects/*}/jobTriggers
Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. |
delete
|
DELETE /v2/{name=projects/*/jobTriggers/*}
Deletes a job trigger. |
get
|
GET /v2/{name=projects/*/jobTriggers/*}
Gets a job trigger. |
list
|
GET /v2/{parent=projects/*}/jobTriggers
Lists job triggers. |
patch
|
PATCH /v2/{name=projects/*/jobTriggers/*}
Updates a job trigger. |
REST Resource: v2.projects.locations.columnDataProfiles
Methods | |
---|---|
get
|
GET /v2/{name=projects/*/locations/*/columnDataProfiles/*}
Gets a column data profile. |
list
|
GET /v2/{parent=projects/*/locations/*}/columnDataProfiles
Lists column data profiles for an organization. |
REST Resource: v2.projects.locations.connections
Methods | |
---|---|
create
|
POST /v2/{parent=projects/*/locations/*}/connections
Create a Connection to an external data source. |
delete
|
DELETE /v2/{name=projects/*/locations/*/connections/*}
Delete a Connection. |
get
|
GET /v2/{name=projects/*/locations/*/connections/*}
Get a Connection by name. |
list
|
GET /v2/{parent=projects/*/locations/*}/connections
Lists Connections in a parent. |
patch
|
PATCH /v2/{name=projects/*/locations/*/connections/*}
Update a Connection. |
search
|
GET /v2/{parent=projects/*/locations/*}/connections:search
Searches for Connections in a parent. |
REST Resource: v2.projects.locations.content
Methods | |
---|---|
deidentify
|
POST /v2/{parent=projects/*/locations/*}/content:deidentify
De-identifies potentially sensitive info from a ContentItem. |
inspect
|
POST /v2/{parent=projects/*/locations/*}/content:inspect
Finds potentially sensitive info in content. |
reidentify
|
POST /v2/{parent=projects/*/locations/*}/content:reidentify
Re-identifies content that has been de-identified. |
REST Resource: v2.projects.locations.deidentifyTemplates
Methods | |
---|---|
create
|
POST /v2/{parent=projects/*/locations/*}/deidentifyTemplates
Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. |
delete
|
DELETE /v2/{name=projects/*/locations/*/deidentifyTemplates/*}
Deletes a DeidentifyTemplate. |
get
|
GET /v2/{name=projects/*/locations/*/deidentifyTemplates/*}
Gets a DeidentifyTemplate. |
list
|
GET /v2/{parent=projects/*/locations/*}/deidentifyTemplates
Lists DeidentifyTemplates. |
patch
|
PATCH /v2/{name=projects/*/locations/*/deidentifyTemplates/*}
Updates the DeidentifyTemplate. |
REST Resource: v2.projects.locations.discoveryConfigs
Methods | |
---|---|
create
|
POST /v2/{parent=projects/*/locations/*}/discoveryConfigs
Creates a config for discovery to scan and profile storage. |
delete
|
DELETE /v2/{name=projects/*/locations/*/discoveryConfigs/*}
Deletes a discovery configuration. |
get
|
GET /v2/{name=projects/*/locations/*/discoveryConfigs/*}
Gets a discovery configuration. |
list
|
GET /v2/{parent=projects/*/locations/*}/discoveryConfigs
Lists discovery configurations. |
patch
|
PATCH /v2/{name=projects/*/locations/*/discoveryConfigs/*}
Updates a discovery configuration. |
REST Resource: v2.projects.locations.dlpJobs
Methods | |
---|---|
cancel
|
POST /v2/{name=projects/*/locations/*/dlpJobs/*}:cancel
Starts asynchronous cancellation on a long-running DlpJob. |
create
|
POST /v2/{parent=projects/*/locations/*}/dlpJobs
Creates a new job to inspect storage or calculate risk metrics. |
delete
|
DELETE /v2/{name=projects/*/locations/*/dlpJobs/*}
Deletes a long-running DlpJob. |
finish
|
POST /v2/{name=projects/*/locations/*/dlpJobs/*}:finish
Finish a running hybrid DlpJob. |
get
|
GET /v2/{name=projects/*/locations/*/dlpJobs/*}
Gets the latest state of a long-running DlpJob. |
hybridInspect
|
POST /v2/{name=projects/*/locations/*/dlpJobs/*}:hybridInspect
Inspect hybrid content and store findings to a job. |
list
|
GET /v2/{parent=projects/*/locations/*}/dlpJobs
Lists DlpJobs that match the specified filter in the request. |
REST Resource: v2.projects.locations.fileStoreDataProfiles
Methods | |
---|---|
delete
|
DELETE /v2/{name=projects/*/locations/*/fileStoreDataProfiles/*}
Delete a FileStoreDataProfile. |
get
|
GET /v2/{name=projects/*/locations/*/fileStoreDataProfiles/*}
Gets a file store data profile. |
list
|
GET /v2/{parent=projects/*/locations/*}/fileStoreDataProfiles
Lists file store data profiles for an organization. |
REST Resource: v2.projects.locations.image
Methods | |
---|---|
redact
|
POST /v2/{parent=projects/*/locations/*}/image:redact
Redacts potentially sensitive info from an image. |
REST Resource: v2.projects.locations.inspectTemplates
Methods | |
---|---|
create
|
POST /v2/{parent=projects/*/locations/*}/inspectTemplates
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. |
delete
|
DELETE /v2/{name=projects/*/locations/*/inspectTemplates/*}
Deletes an InspectTemplate. |
get
|
GET /v2/{name=projects/*/locations/*/inspectTemplates/*}
Gets an InspectTemplate. |
list
|
GET /v2/{parent=projects/*/locations/*}/inspectTemplates
Lists InspectTemplates. |
patch
|
PATCH /v2/{name=projects/*/locations/*/inspectTemplates/*}
Updates the InspectTemplate. |
REST Resource: v2.projects.locations.jobTriggers
Methods | |
---|---|
activate
|
POST /v2/{name=projects/*/locations/*/jobTriggers/*}:activate
Activate a job trigger. |
create
|
POST /v2/{parent=projects/*/locations/*}/jobTriggers
Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. |
delete
|
DELETE /v2/{name=projects/*/locations/*/jobTriggers/*}
Deletes a job trigger. |
get
|
GET /v2/{name=projects/*/locations/*/jobTriggers/*}
Gets a job trigger. |
hybridInspect
|
POST /v2/{name=projects/*/locations/*/jobTriggers/*}:hybridInspect
Inspect hybrid content and store findings to a trigger. |
list
|
GET /v2/{parent=projects/*/locations/*}/jobTriggers
Lists job triggers. |
patch
|
PATCH /v2/{name=projects/*/locations/*/jobTriggers/*}
Updates a job trigger. |
REST Resource: v2.projects.locations.projectDataProfiles
Methods | |
---|---|
get
|
GET /v2/{name=projects/*/locations/*/projectDataProfiles/*}
Gets a project data profile. |
list
|
GET /v2/{parent=projects/*/locations/*}/projectDataProfiles
Lists project data profiles for an organization. |
REST Resource: v2.projects.locations.storedInfoTypes
Methods | |
---|---|
create
|
POST /v2/{parent=projects/*/locations/*}/storedInfoTypes
Creates a pre-built stored infoType to be used for inspection. |
delete
|
DELETE /v2/{name=projects/*/locations/*/storedInfoTypes/*}
Deletes a stored infoType. |
get
|
GET /v2/{name=projects/*/locations/*/storedInfoTypes/*}
Gets a stored infoType. |
list
|
GET /v2/{parent=projects/*/locations/*}/storedInfoTypes
Lists stored infoTypes. |
patch
|
PATCH /v2/{name=projects/*/locations/*/storedInfoTypes/*}
Updates the stored infoType by creating a new version. |
REST Resource: v2.projects.locations.tableDataProfiles
Methods | |
---|---|
delete
|
DELETE /v2/{name=projects/*/locations/*/tableDataProfiles/*}
Delete a TableDataProfile. |
get
|
GET /v2/{name=projects/*/locations/*/tableDataProfiles/*}
Gets a table data profile. |
list
|
GET /v2/{parent=projects/*/locations/*}/tableDataProfiles
Lists table data profiles for an organization. |
REST Resource: v2.projects.storedInfoTypes
Methods | |
---|---|
create
|
POST /v2/{parent=projects/*}/storedInfoTypes
Creates a pre-built stored infoType to be used for inspection. |
delete
|
DELETE /v2/{name=projects/*/storedInfoTypes/*}
Deletes a stored infoType. |
get
|
GET /v2/{name=projects/*/storedInfoTypes/*}
Gets a stored infoType. |
list
|
GET /v2/{parent=projects/*}/storedInfoTypes
Lists stored infoTypes. |
patch
|
PATCH /v2/{name=projects/*/storedInfoTypes/*}
Updates the stored infoType by creating a new version. |