submission_search

Autogenerated API

argus_api.lib.sampledb.v1.submission.submission_search.get_submission_by_id(id: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict

Fetch submission info identified by id. (PUBLIC)

Parameters

• id (int) – Submission ID

• json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

• verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

• apiKey – Argus API key.

• authentication – authentication override

• server_url – API base URL override

• body – body of the request. other parameters will override keys defined in the body.

• api_session – session to use for this request. If not set, the global session will be used.

Raises

• AuthenticationFailedException – on 401

• AccessDeniedException – on 403

• ObjectNotFoundException – on 404

• ValidationErrorException – on 412

• ArgusException – on other status codes

Returns

dictionary translated from JSON

argus_api.lib.sampledb.v1.submission.submission_search.search_meta_submissions(customerID: int = None, tlp: str = None, keywords: str = None, startTimestamp: int = None, endTimestamp: int = None, includeAnonymousResults: bool = True, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict

Search for submissions matching given search criteria (PUBLIC)

Parameters

• customerID (list) – Set of customer IDs containing submissions. If not specified, search will be performed against all accessible customers.

• tlp (list) – Set of TLPs to search for. If not specified, search will be performed against all TLPs (WHITE, GREEN, AMBER, RED).

• keywords (list) – A set of keywords matched against the metafields of the submission.

• startTimestamp (int) – Start of time search period for submission creation date. (default 7 days before timestamp of request.)

• endTimestamp (int) – End of time search period for submission creation date. (default Timestamp of request.)

• includeAnonymousResults (bool) – Whether include anonymous results (default true)

• limit (int) – Set this value to set max number of results. (default 25)

• offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object. (default 0)

• json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

• verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

• apiKey – Argus API key.

• authentication – authentication override

• server_url – API base URL override

• body – body of the request. other parameters will override keys defined in the body.

• api_session – session to use for this request. If not set, the global session will be used.

Raises

• AuthenticationFailedException – on 401

• AccessDeniedException – on 403

• ValidationErrorException – on 412

• ArgusException – on other status codes

Returns

dictionary translated from JSON