Method: legacySearches.legacyEntitySearchCount

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

legacySearches.legacyEntitySearchCount to get entities count.

HTTP request


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

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 
{
  "term": string,
  "type": [
    string
  ],
  "networkName": [
    string
  ],
  "environmentsName": [
    string
  ],
  "requestedPage": integer,
  "pageSize": integer,
  "requestingUser": string,
  "isSuspicious": boolean,
  "isInternalAsset": boolean,
  "isEnriched": boolean
}
Fields
term

string

Optional. Search term.
type[]

string

Optional. List of entity types.
networkName[]

string

Optional. List of network names.
environmentsName[]

string

Optional. List of environment names.
requestedPage

integer

Optional. The requested page.
pageSize

integer

Optional. Number of entries to return.
requestingUser

string

Optional. Requesting user.
isSuspicious

boolean

Optional. Is suspicious.
isInternalAsset

boolean

Optional. Is internal asset.
isEnriched

boolean

Optional. Is enriched.

Response body

Response for legacySearches.legacyEntitySearchCount.

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

JSON representation 
{
  "payload": integer
}
Fields
payload

integer

Optional. The count.

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.