cpe#

Autogenerated API

argus_api.lib.assets.v2.cpe.get_asset_cpes(idOrWFN: str, 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#

Get CPE by ID or WFN (DEV)

Parameters

  • idOrWFN (str) – CPE ID or WFN

  • 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
Returns

dictionary translated from JSON

argus_api.lib.assets.v2.cpe.list_asset_cpes(keywords: str = None, vendor: str = None, product: str = None, version: str = None, sortBy: str = None, startTimestamp: str = '0', endTimestamp: str = '0', limit: int = 25, includeDeprecated: bool = None, 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#

Basic CPE search. (DEV)

Parameters

  • keywords (list) – Match keywords against all available CPE keyword fields

  • vendor (list) – CPE Vendor

  • product (list) – CPE Product

  • version (list) – CPE Version

  • sortBy (list) – Field(s) to sort by - refer to the search POST endpoint to see which fields are permitted

  • startTimestamp (str) – Lower bound timestamp filter value against all available CPE timestamp fields

  • endTimestamp (str) – Upper bound timestamp filter value against all available CPE timestamp fields

  • limit (int) – Limit result set

  • includeDeprecated (bool) – Whether to include deprecated CPEs in the results

  • offset (int) – Offset result set

  • 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.

Returns

dictionary translated from JSON

argus_api.lib.assets.v2.cpe.search_cpes(keywords: str = None, keywordFieldStrategy: str = None, keywordMatchStrategy: str = None, cpe: str = None, part: str = None, vendor: str = None, product: str = None, version: str = None, startTimestamp: str = None, endTimestamp: str = None, timeFieldStrategy: str = None, timeMatchStrategy: str = None, deprecates: str = None, deprecatedBy: str = None, includeFlags: str = None, excludeFlags: str = None, subCriteria: dict = None, sortBy: str = None, limit: int = 25, offset: int = None, includeDeprecated: bool = 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 CPEs (DEV)

Parameters

  • keywords (list) – Search for keywords against fields defined by a KeywordFieldStrategy

  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields) (default all)

  • keywordMatchStrategy (str) – Defines how strict different keywords should be matched (default match any keywords) (default any)

  • cpe (list) – Filter for CPEs matching one of these WFN or ID values

  • part (list) – Filter for CPEs matching one of these part values

  • vendor (list) – Filter for CPEs matching one of these vendors values

  • product (list) – Filter for CPEs matching one of these products values

  • version (list) – Filter for CPEs matching one of these versions values

  • startTimestamp (str) – Restrict to a time frame based on the set timeFieldStrategy (start timestamp). (default 0)

  • endTimestamp (str) – Restrict to a time frame based on the set timeFieldStrategy (end timestamp). (default 0)

  • timeFieldStrategy (list) – Defines which timestamps fields will be filtered with start/endTimestamp (default all)

  • timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any) (default any)

  • deprecates (list) – Filter for CPEs that deprecate at least one of these CPEs identified by ID or WFN

  • deprecatedBy (list) – Filter for CPEs deprecated by at least one of these CPEs identified by ID or WFN

  • includeFlags (list) – Explicitly search for CPEs that contain these flags

  • excludeFlags (list) – Explicitly filter out CPEs that contain these flags

  • subCriteria (list) – Set additional criteria that are applied with logical OR by default

  • sortBy (list) – Field(s) by which to sort the results

  • limit (int) – Limit the results to the specified amount (default 25)

  • offset (int) – Skip specified amount of results (default 0)

  • includeDeprecated (bool) – Whether to include deprecated CPEs (default false)

  • 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
Returns

dictionary translated from JSON