Method: legacyPlaybooks.legacyGetContextGroupByKey

Full name: projects.locations.instances.legacyPlaybooks.legacyGetContextGroupByKey

Returns the context group associated with a specific key. Use this method to retrieve a collection of related security data points (e.g., entity enrichment) grouped for efficient access.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{instance}/legacyPlaybooks:legacyGetContextGroupByKey

Path parameters

Parameters
instance

string

Required. The instance to get the context group by key for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
contextGroupKey

string

Required. The key to get the context group by key for.

Request body

The request body must be empty.

Response body

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

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 instance resource:

  • chronicle.legacyPlaybooks.get

For more information, see the IAM documentation.