Skip to content

Commit 9d24f8f

Browse files
Add the ticloud param to advanced_search_v2 and advanced_search_v2_aggregated
1 parent c926c07 commit 9d24f8f

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

ReversingLabs/SDK/a1000.py

+12-3
Original file line numberDiff line numberDiff line change
@@ -1941,7 +1941,7 @@ def advanced_search_aggregated(self, query_string, max_results=5000, sorting_cri
19411941

19421942
return results
19431943

1944-
def advanced_search_v2(self, query_string, page_number=1, records_per_page=20, sorting_criteria=None,
1944+
def advanced_search_v2(self, query_string, ticloud=False, page_number=1, records_per_page=20, sorting_criteria=None,
19451945
sorting_order="desc"):
19461946
"""Sends a query string to the A1000 Advanced Search API v2.
19471947
The query string must be composed of key-value pairs separated by space.
@@ -1953,6 +1953,8 @@ def advanced_search_v2(self, query_string, page_number=1, records_per_page=20, s
19531953
19541954
:param query_string: query string
19551955
:type query_string: str
1956+
:param ticloud: show only cloud results
1957+
:type ticloud: bool
19561958
:param page_number: page number
19571959
:type page_number: int
19581960
:param records_per_page: number of records returned per page; maximum value is 100
@@ -1968,13 +1970,17 @@ def advanced_search_v2(self, query_string, page_number=1, records_per_page=20, s
19681970
if not isinstance(query_string, str):
19691971
raise WrongInputError("The search query must be a string.")
19701972

1973+
if not isinstance(ticloud, bool):
1974+
raise WrongInputError("ticloud parameter must be boolean.")
1975+
19711976
if not isinstance(records_per_page, int) or not 1 <= records_per_page <= 100:
19721977
raise WrongInputError("records_per_page parameter must be an integer with a value "
19731978
"between 1 and 100 (included).")
19741979

19751980
url = self._url.format(endpoint=self.__ADVANCED_SEARCH_ENDPOINT_V2)
19761981

1977-
post_json = {"query": query_string, "page": page_number, "records_per_page": records_per_page}
1982+
post_json = {"query": query_string, "ticloud": ticloud, "page": page_number,
1983+
"records_per_page": records_per_page}
19781984

19791985
if sorting_criteria:
19801986
if sorting_criteria not in ADVANCED_SEARCH_SORTING_CRITERIA or sorting_order not in ("desc", "asc"):
@@ -1995,7 +2001,7 @@ def advanced_search_v2(self, query_string, page_number=1, records_per_page=20, s
19952001

19962002
return response
19972003

1998-
def advanced_search_v2_aggregated(self, query_string, max_results=5000, sorting_criteria=None,
2004+
def advanced_search_v2_aggregated(self, query_string, ticloud=False, max_results=5000, sorting_criteria=None,
19992005
sorting_order="desc"):
20002006
"""Sends a query string to the A1000 Advanced Search API v2.
20012007
The query string must be composed of key-value pairs separated by space.
@@ -2009,6 +2015,8 @@ def advanced_search_v2_aggregated(self, query_string, max_results=5000, sorting
20092015
20102016
:param query_string: search query - see API documentation for details on writing search queries
20112017
:type query_string: str
2018+
:param ticloud: show only cloud results
2019+
:type ticloud: bool
20122020
:param max_results: maximum results to be returned in a list; default value is 5000
20132021
:type max_results: int
20142022
:param sorting_criteria: define the criteria used in sorting; possible values are 'sha1', 'firstseen',
@@ -2029,6 +2037,7 @@ def advanced_search_v2_aggregated(self, query_string, max_results=5000, sorting
20292037
while more_pages:
20302038
response = self.advanced_search_v2(
20312039
query_string=query_string,
2040+
ticloud=ticloud,
20322041
page_number=next_page,
20332042
records_per_page=100,
20342043
sorting_criteria=sorting_criteria,

0 commit comments

Comments
 (0)