Method: instances.searchEntities

Full name: projects.locations.instances.searchEntities

Identifies the entity type and retrieves relevant data associated with a specified indicator. The API returns a maximum of 1000 entities.

HTTP request


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

Path parameters

Parameters
instance

string

Required. The ID of the Instance to search entities for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
indicator

string

Required. Value of indicator tied to an entity.
pageSize
(deprecated)

integer

Optional. Deprecated: Pagination is not supported for this API. The maximum number of Entities to return. The service may return fewer than this value. If unspecified, at most 1000 entities will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken
(deprecated)

string

Optional. Deprecated: Pagination is not supported for this API. A page token, received from a previous SearchEntitiesRequest call. Provide this to retrieve the subsequent page.

Request body

The request body must be empty.

Response body

Response message for search entities.

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

JSON representation 
{
  "entities": [
    {
      object (Entity)
    }
  ],
  "nextPageToken": string
}
Fields
entities[]

object (Entity)

A list of entities.
nextPageToken
(deprecated)

string

Deprecated: Pagination is not supported for this API. A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

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.entities.searchEntities

For more information, see the IAM documentation.