Method: projects.locations.securityHealthAnalyticsCustomModules.delete

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the resource hierarchy. This method is only supported for resident custom modules.

HTTP request

DELETE https://securitycentermanagement.googleapis.com/v1/{name=projects/*/locations/*/securityHealthAnalyticsCustomModules/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the SHA custom module, in one of the following formats:

  • organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}

Query parameters

Parameters
validateOnly

boolean

Optional. When set to true, the request will be validated (including IAM checks), but no module will be deleted. An OK response indicates that the request is valid, while an error response indicates that the request is invalid.

If the request is valid, a subsequent request to delete the module could still fail for one of the following reasons:

  • The state of your cloud resources changed; for example, you lost a required IAM permission
  • An error occurred during deletion of the module

Defaults to false.

Request body

The request body must be empty.

Response body

If successful, the response body is 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 IAM permission on the name resource:

  • securitycentermanagement.securityHealthAnalyticsCustomModules.delete

For more information, see the IAM documentation.