Method: environmentGroups.patch

Full name: projects.locations.instances.environmentGroups.patch

Updates an existing EnvironmentGroup. Use this method to change the displayName, description, or the list of environmentsIds. The new display name must not conflict with other existing groups.

HTTP request


PATCH https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{environmentGroup.name}

Path parameters

Parameters
environmentGroup.name

string

Identifier. The resource name of the environment group. Format: projects/{project}/locations/{location}/instances/{instance}/environmentGroups/{environmentGroup}

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The list of fields to update. Supported paths are - displayName description environments * - update all fields

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

Request body

The request body contains an instance of EnvironmentGroup.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.environmentGroups.update

For more information, see the IAM documentation.