Method: organizations.locations.securityCenterServices.patch

Updates a Security Command Center service using the given update mask.

HTTP request

PATCH https://securitycentermanagement.googleapis.com/v1/{securityCenterService.name=organizations/*/locations/*/securityCenterServices/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
securityCenterService.name

string

Identifier. The name of the service, in one of the following formats:

  • organizations/{organization}/locations/{location}/securityCenterServices/{service}
  • folders/{folder}/locations/{location}/securityCenterServices/{service}
  • projects/{project}/locations/{location}/securityCenterServices/{service}

The following values are valid for {service}:

  • container-threat-detection
  • event-threat-detection
  • security-health-analytics
  • vm-threat-detection
  • web-security-scanner

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The fields to update. Accepts the following values:

  • intendedEnablementState
  • modules

If omitted, then all eligible fields are updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
validateOnly

boolean

Optional. When set to true, the request will be validated (including IAM checks), but no service will be updated. 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 update the service 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 update of the service

Defaults to false.

Request body

The request body contains an instance of SecurityCenterService.

Response body

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

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.securityCenterServices.update

For more information, see the IAM documentation.