Security Data

class py42.clients.securitydata.SecurityDataClient(file_event_service, preservation_data_service, saved_search_service, storage_service_factory)

Bases: object

property savedsearches

A collection of methods related to retrieving forensic search data.

Returns

class: py42.services.savedsearch.SavedSearchService

search_all_file_events(query, page_token='')

Searches for all file events, returning a page of events with a token in the response to retrieve next page. REST Documentation

Parameters
  • query (str or py42.sdk.queries.fileevents.file_event_query.FileEventQuery) – The file event query to filter search results.

  • page_token (str, optional) – A token used to indicate the starting point for additional page results. For the first page, do not pass page_token. For all consecutive pages, pass the token from the previous response from field nextPgToken. Defaults to empty string.

Returns

A response containing a page of events.

Return type

py42.response.Py42Response

search_file_events(query)

Searches for file events, returns up to the first 10,000 events. REST Documentation

Parameters

query (str or py42.sdk.queries.fileevents.file_event_query.FileEventQuery) – The file event query to filter search results.

Returns

A response containing the first 10,000 events.

Return type

py42.response.Py42Response

stream_file_by_md5(checksum)

Stream file based on MD5 checksum.

Parameters

checksum (str) – MD5 hash of the file.

Returns

Returns a stream of the requested file.

stream_file_by_sha256(checksum)

Stream file based on SHA256 checksum.

Parameters

checksum (str) – SHA256 hash of the file.

Returns

Returns a stream of the requested file.