Method: legacySearches.legacyGetEntitiesFilterValues

Full name: projects.locations.instances.legacySearches.legacyGetEntitiesFilterValues

legacySearches.legacyGetEntitiesFilterValues to get entities filter values.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{instance}/legacySearches:legacyGetEntitiesFilterValues

Path parameters

Parameters
instance

string

Required. The instance to get the search results for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation
{
  "typeOfFilter": enum (EntitySearchFilterTypeEnum),
  "numberOfValuesToReturn": integer,
  "searchTerm": string
}
Fields
typeOfFilter

enum (EntitySearchFilterTypeEnum)

Required. Type of filter.

numberOfValuesToReturn

integer

Optional. Number of values to return.

searchTerm

string

Optional. Search term.

Response body

Response for legacySearches.legacyGetEntitiesFilterValues.

If successful, the response body contains data with the following structure:

JSON representation
{
  "payload": [
    string
  ]
}
Fields
payload[]

string

Optional. The filter values.

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

  • chronicle.legacySearches.searchEntities

For more information, see the IAM documentation.

EntitySearchFilterTypeEnum

Enum that represents the entity search filter type.

Enums
OPERATION_SYSTEM Operation System filter type.
NETWORK Network filter type.
COUNTRY Country filter type.
ENVIRONMENT Environment filter type.