nvd_api.low_api.api package

Submodules

nvd_api.low_api.api.products_api module

NVD API 2.0 Python API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501

The version of the OpenAPI document: 0.1.0 Contact: 15080890+kannkyo@users.noreply.github.com Generated by: https://openapi-generator.tech

class nvd_api.low_api.api.products_api.ProductsApi(api_client=None)[source]

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

get_cpe_match(**kwargs)[source]

Match Criteria API # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_cpe_match(async_req=True)
>>> result = thread.get()
Keyword Arguments:

  • cve_id (str) – CVE ID. [optional]

  • last_mod_start_date (datetime) – search by modified date. [optional]

  • last_mod_end_date (datetime) – search by modified date. [optional]

  • match_criteria_id (str) – specific by UUID. [optional]

  • results_per_page (int) – max number of records (default is 5000). [optional]

  • start_index (int) – the index of the first match string. [optional]

  • _return_http_data_only (bool) – response data without head status code and headers. Default is True.

  • _preload_content (bool) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout (int/float/tuple) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. Default is None.

  • _check_input_type (bool) – specifies if type checking should be done one the data sent to the server. Default is True.

  • _check_return_type (bool) – specifies if type checking should be done one the data received from the server. Default is True.

  • _spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default)

  • _content_type (str/None) – force body content-type. Default is None and content-type will be predicted by allowed content-types and body.

  • _host_index (int/None) – specifies the index of the server that we want to use. Default is read from the configuration.

  • _request_auths (list) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. Default is None

  • async_req (bool) – execute request asynchronously

Returns:

CpeMatchOas

If the method is called asynchronously, returns the request thread.

get_cpes(**kwargs)[source]

CPE API # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_cpes(async_req=True)
>>> result = thread.get()
Keyword Arguments:

  • cpe_name_id (str) – specific CPE record UUID. [optional]

  • cpe_match_string (str) – CPE Name. [optional]

  • keyword_exact_match (str) – if CPE exactly match or not. [optional] if omitted the server will use the default value of “”

  • keyword_search (str) – a word or phrase is found in the metadata title or reference links. [optional]

  • last_mod_start_date (datetime) – search CPE by modified date. [optional]

  • last_mod_end_date (datetime) – search CPE by modified date. [optional]

  • match_criteria_id (str) – search CPE by uuid. [optional]

  • results_per_page (int) – max number of CPE records (default is 10000). [optional]

  • start_index (int) – the index of the first match string. [optional]

  • _return_http_data_only (bool) – response data without head status code and headers. Default is True.

  • _preload_content (bool) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout (int/float/tuple) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. Default is None.

  • _check_input_type (bool) – specifies if type checking should be done one the data sent to the server. Default is True.

  • _check_return_type (bool) – specifies if type checking should be done one the data received from the server. Default is True.

  • _spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default)

  • _content_type (str/None) – force body content-type. Default is None and content-type will be predicted by allowed content-types and body.

  • _host_index (int/None) – specifies the index of the server that we want to use. Default is read from the configuration.

  • _request_auths (list) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. Default is None

  • async_req (bool) – execute request asynchronously

Returns:

CpeOas

If the method is called asynchronously, returns the request thread.

nvd_api.low_api.api.vulnerabilities_api module

NVD API 2.0 Python API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501

The version of the OpenAPI document: 0.1.0 Contact: 15080890+kannkyo@users.noreply.github.com Generated by: https://openapi-generator.tech

class nvd_api.low_api.api.vulnerabilities_api.VulnerabilitiesApi(api_client=None)[source]

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

get_cve_history(**kwargs)[source]

CVE Change History API # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_cve_history(async_req=True)
>>> result = thread.get()
Keyword Arguments:

  • change_start_date (datetime) – search by changed date. [optional]

  • change_end_date (datetime) – search by changed date. [optional]

  • cve_id (str) – CVE ID. [optional]

  • event_name (str) – returns all CVE associated with a specific type of change event. [optional]

  • results_per_page (int) – max number of records (default is 5000). [optional]

  • start_index (int) – the index of the first match string. [optional]

  • _return_http_data_only (bool) – response data without head status code and headers. Default is True.

  • _preload_content (bool) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout (int/float/tuple) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. Default is None.

  • _check_input_type (bool) – specifies if type checking should be done one the data sent to the server. Default is True.

  • _check_return_type (bool) – specifies if type checking should be done one the data received from the server. Default is True.

  • _spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default)

  • _content_type (str/None) – force body content-type. Default is None and content-type will be predicted by allowed content-types and body.

  • _host_index (int/None) – specifies the index of the server that we want to use. Default is read from the configuration.

  • _request_auths (list) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. Default is None

  • async_req (bool) – execute request asynchronously

Returns:

CveHistoryOas

If the method is called asynchronously, returns the request thread.

get_cves(**kwargs)[source]

CVE API # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_cves(async_req=True)
>>> result = thread.get()
Keyword Arguments:

  • cpe_name (str) – CPE Name. [optional]

  • cve_id (str) – CVE ID. [optional]

  • cvss_v2_metrics (str) – CVSSv2 vector string. [optional]

  • cvss_v2_severity (str) – CVSSv2 qualitative severity rating. [optional]

  • cvss_v3_metrics (str) – CVSSv3 vector string. [optional]

  • cvss_v3_severity (str) – CVSSv3 qualitative severity rating. [optional]

  • cwe_id (str) – CWE ID. [optional]

  • has_cert_alerts (str) – contain a Technical Alert from US-CERT. [optional] if omitted the server will use the default value of “”

  • has_cert_notes (str) – contain a Vulnerability Note from CERT/CC. [optional] if omitted the server will use the default value of “”

  • has_kev (str) – appear in CISA’s Known Exploited Vulnerabilities (KEV) Catalog. [optional] if omitted the server will use the default value of “”

  • has_oval (str) – contain information from MITRE’s Open Vulnerability and Assessment Language (OVAL). [optional] if omitted the server will use the default value of “”

  • is_vulnerable (str) – returns only CVE associated with a specific CPE. [optional] if omitted the server will use the default value of “”

  • keyword_exact_match (str) – returns any CVE where a word or phrase. [optional] if omitted the server will use the default value of “”

  • keyword_search (str) – a word or phrase is found in the current description. [optional]

  • last_mod_start_date (datetime) – search by modified date. [optional]

  • last_mod_end_date (datetime) – search by modified date. [optional]

  • no_rejected (str) – return the CVE API includes CVE records with the REJECT or Rejected status. [optional] if omitted the server will use the default value of “”

  • pub_start_date (datetime) – search by published date. [optional]

  • pub_end_date (datetime) – search by published date. [optional]

  • results_per_page (int) – max number of records (default is 2000). [optional]

  • start_index (int) – the index of the first match string. [optional]

  • source_identifier (str) – returns CVE where the exact value of sourceIdentifier appears. [optional]

  • version_end (str) – return only the CVEs associated with CPEs in specific version ranges. [optional]

  • version_end_type (str) – return only the CVEs associated with CPEs in specific version ranges. [optional]

  • version_start (str) – return only the CVEs associated with CPEs in specific version ranges. [optional]

  • version_start_type (str) – return only the CVEs associated with CPEs in specific version ranges. [optional]

  • virtual_match_string (str) – CVE more broadly than cpeName. [optional]

  • _return_http_data_only (bool) – response data without head status code and headers. Default is True.

  • _preload_content (bool) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout (int/float/tuple) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. Default is None.

  • _check_input_type (bool) – specifies if type checking should be done one the data sent to the server. Default is True.

  • _check_return_type (bool) – specifies if type checking should be done one the data received from the server. Default is True.

  • _spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default)

  • _content_type (str/None) – force body content-type. Default is None and content-type will be predicted by allowed content-types and body.

  • _host_index (int/None) – specifies the index of the server that we want to use. Default is read from the configuration.

  • _request_auths (list) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request. Default is None

  • async_req (bool) – execute request asynchronously

Returns:

CveOas

If the method is called asynchronously, returns the request thread.

Module contents