Method: projects.detectorSettings.clear

Clear the organization or project's detector settings and return the settings to the default. Detector settings are present at the organization and the project level. Using Clear for a project will remove the override that was set and result in the organization-level detector settings being used.

HTTP request

POST https://threatdetection.googleapis.com/v1beta1/{name=projects/*/detectorSettings}:clear

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Resource name of the organization-level or project-level detector settings. Its format is "organizations/[organization_id]/detectorSettings" or "projects/[project_number]/detectorSettings".

Request body

The request body contains data with the following structure:

JSON representation
{
  "recursive": boolean
}
Fields
recursive

boolean

If true when the resource is an organization's settings, it will clear out the project settings under that organization too.

Response body

If successful, the response body will be empty.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following Cloud IAM permission on the name resource:

  • threatdetection.detectorSettings.clear

For more information, see the Cloud IAM Documentation.