nvd_api package

Subpackages

• nvd_api.low_api package
  • Subpackages
    • nvd_api.low_api.api package
      • Submodules
      • nvd_api.low_api.api.products_api module
      • nvd_api.low_api.api.vulnerabilities_api module
      • Module contents
    • nvd_api.low_api.apis package
      • Module contents
    • nvd_api.low_api.model package
      • Submodules
      • nvd_api.low_api.model.cpe_match_oas module
      • nvd_api.low_api.model.cpe_match_oas_match_strings_inner module
      • nvd_api.low_api.model.cpe_match_oas_match_strings_inner_match_string module
      • nvd_api.low_api.model.cpe_match_oas_match_strings_inner_match_string_matches_inner module
      • nvd_api.low_api.model.cpe_oas module
      • nvd_api.low_api.model.cpe_oas_products_inner module
      • nvd_api.low_api.model.cpe_oas_products_inner_cpe module
      • nvd_api.low_api.model.cpe_oas_products_inner_cpe_deprecated_by_inner module
      • nvd_api.low_api.model.cpe_oas_products_inner_cpe_refs_inner module
      • nvd_api.low_api.model.cpe_oas_products_inner_cpe_titles_inner module
      • nvd_api.low_api.model.cve_history_oas module
      • nvd_api.low_api.model.cve_history_oas_cve_changes_inner module
      • nvd_api.low_api.model.cve_history_oas_cve_changes_inner_change module
      • nvd_api.low_api.model.cve_history_oas_cve_changes_inner_change_details_inner module
      • nvd_api.low_api.model.cve_oas module
      • nvd_api.low_api.model.cve_oas_vulnerabilities_inner module
      • nvd_api.low_api.model.cve_oas_vulnerabilities_inner_cve module
      • nvd_api.low_api.model.cve_oas_vulnerabilities_inner_cve_configurations_inner module
      • nvd_api.low_api.model.cve_oas_vulnerabilities_inner_cve_configurations_inner_nodes_inner module
      • nvd_api.low_api.model.cve_oas_vulnerabilities_inner_cve_configurations_inner_nodes_inner_cpe_match_inner module
      • nvd_api.low_api.model.cve_oas_vulnerabilities_inner_cve_descriptions_inner module
      • nvd_api.low_api.model.cve_oas_vulnerabilities_inner_cve_metrics module
      • nvd_api.low_api.model.cve_oas_vulnerabilities_inner_cve_metrics_cvss_metric_v2_inner module
      • nvd_api.low_api.model.cve_oas_vulnerabilities_inner_cve_metrics_cvss_metric_v30_inner module
      • nvd_api.low_api.model.cve_oas_vulnerabilities_inner_cve_metrics_cvss_metric_v31_inner module
      • nvd_api.low_api.model.cve_oas_vulnerabilities_inner_cve_references_inner module
      • nvd_api.low_api.model.cve_oas_vulnerabilities_inner_cve_vendor_comments_inner module
      • nvd_api.low_api.model.cve_oas_vulnerabilities_inner_cve_weaknesses_inner module
      • nvd_api.low_api.model.json_schema_for_common_vulnerability_scoring_system_version20 module
      • nvd_api.low_api.model.json_schema_for_common_vulnerability_scoring_system_version30 module
      • nvd_api.low_api.model.json_schema_for_common_vulnerability_scoring_system_version31 module
      • Module contents
    • nvd_api.low_api.models package
      • Module contents
  • Submodules
  • nvd_api.low_api.api_client module
    • ApiClient
      • ApiClient.call_api()
      • ApiClient.close()
      • ApiClient.deserialize()
      • ApiClient.files_parameters()
      • ApiClient.get_file_data_and_close_file()
      • ApiClient.parameters_to_multipart()
      • ApiClient.parameters_to_tuples()
      • ApiClient.pool
      • ApiClient.request()
      • ApiClient.sanitize_for_serialization()
      • ApiClient.select_header_accept()
      • ApiClient.select_header_content_type()
      • ApiClient.set_default_header()
      • ApiClient.update_params_for_auth()
      • ApiClient.user_agent
    • Endpoint
      • Endpoint.call_with_http_info()
  • nvd_api.low_api.configuration module
    • Configuration
      • Configuration.assert_hostname
      • Configuration.auth_settings()
      • Configuration.cert_file
      • Configuration.connection_pool_maxsize
      • Configuration.debug
      • Configuration.get_api_key_with_prefix()
      • Configuration.get_basic_auth_token()
      • Configuration.get_default_copy()
      • Configuration.get_host_from_settings()
      • Configuration.get_host_settings()
      • Configuration.host
      • Configuration.key_file
      • Configuration.logger
      • Configuration.logger_file
      • Configuration.logger_file_handler
      • Configuration.logger_format
      • Configuration.logger_stream_handler
      • Configuration.no_proxy
      • Configuration.password
      • Configuration.proxy
      • Configuration.proxy_headers
      • Configuration.refresh_api_key_hook
      • Configuration.retries
      • Configuration.safe_chars_for_path_param
      • Configuration.server_operation_index
      • Configuration.server_operation_variables
      • Configuration.set_default()
      • Configuration.ssl_ca_cert
      • Configuration.temp_folder_path
      • Configuration.to_debug_report()
      • Configuration.username
      • Configuration.verify_ssl
  • nvd_api.low_api.exceptions module
    • ApiAttributeError
    • ApiException
    • ApiKeyError
    • ApiTypeError
    • ApiValueError
    • ForbiddenException
    • NotFoundException
    • OpenApiException
    • ServiceException
    • UnauthorizedException
    • render_path()
  • nvd_api.low_api.model_utils module
    • ModelComposed
      • ModelComposed.get()
      • ModelComposed.to_dict()
      • ModelComposed.to_str()
    • ModelNormal
      • ModelNormal.get()
      • ModelNormal.to_dict()
      • ModelNormal.to_str()
    • ModelSimple
      • ModelSimple.get()
      • ModelSimple.to_str()
    • OpenApiModel
      • OpenApiModel.set_attribute()
    • allows_single_value_input()
    • attempt_convert_item()
    • cached_property
      • cached_property.result_key
    • change_keys_js_to_python()
    • check_allowed_values()
    • check_validations()
    • composed_model_input_classes()
    • convert_js_args_to_python_args()
    • deserialize_file()
    • deserialize_model()
    • deserialize_primitive()
    • get_allof_instances()
    • get_anyof_instances()
    • get_discarded_args()
    • get_discriminated_classes()
    • get_discriminator_class()
    • get_oneof_instance()
    • get_possible_classes()
    • get_required_type_classes()
    • get_simple_class()
    • get_type_error()
    • get_valid_classes_phrase()
    • is_json_validation_enabled()
    • is_type_nullable()
    • is_valid_type()
    • model_to_dict()
    • order_response_types()
    • remove_uncoercible()
    • type_error_message()
    • validate_and_convert_types()
    • validate_get_composed_info()
  • nvd_api.low_api.rest module
    • RESTClientObject
      • RESTClientObject.DELETE()
      • RESTClientObject.GET()
      • RESTClientObject.HEAD()
      • RESTClientObject.OPTIONS()
      • RESTClientObject.PATCH()
      • RESTClientObject.POST()
      • RESTClientObject.PUT()
      • RESTClientObject.request()
    • RESTResponse
      • RESTResponse.getheader()
      • RESTResponse.getheaders()
    • in_ipv4net()
    • is_ipv4()
    • should_bypass_proxies()
  • Module contents

Submodules

nvd_api.client module

class nvd_api.client.CVSS_V2_SEVERITY(value)

Bases: Enum

CVSS v2 severity level

HIGH = 'HIGH'

LOW = 'LOW'

MEDIUM = 'MEDIUM'

class nvd_api.client.CVSS_V3_SEVERITY(value)

Bases: Enum

CVSS v3 severity level

CRITICAL = 'CRITICAL'

HIGH = 'HIGH'

LOW = 'LOW'

MEDIUM = 'MEDIUM'

class nvd_api.client.EVENT_NAME(value)

Bases: Enum

“CVE associated with a specific type of change event name

CPE_DEPRECATION_REMAP = 'CPE Deprecation Remap'

CVE_MODIFIED = 'CVE Modified'

CVE_REJECTED = 'CVE Rejected'

CVE_SOURCE_UPDATE = 'CVE Source Update'

CVE_TRANSLATED = 'CVE Translated'

CVE_UNREJECTED = 'CVE Unrejected'

CWE_REMAP = 'CWE Remap'

INITIAL_ANALYSIS = 'Initial Analysis'

MODIFIED_ANALYSIS = 'Modified Analysis'

REANALYSIS = 'Reanalysis'

VENDOR_COMMENT = 'Vendor Comment'

class nvd_api.client.NvdApiClient(wait_time: int = 6000, request_timeout: int = 20000, max_retries: int = 3, api_key: str | None = None)

Bases: object

NVD API Client class

MAX_PAGE_LIMIT_CPE_API = 10000

MAX_PAGE_LIMIT_CPE_MATCH_API = 5000

MAX_PAGE_LIMIT_CVE_API = 2000

MAX_PAGE_LIMIT_CVE_HISTORY_API = 5000

get_all_cpe_match(cve_id: str | None = None, last_mod_start_date: datetime | None = None, last_mod_end_date: datetime | None = None, match_criteria_id: str | None = None) → CpeMatchOas

All Match Criteria API # noqa: E501

Parameters:

• cve_id (str, optional) – CVE ID. Defaults to None.

• last_mod_start_date (datetime, optional) – search by modified date. Defaults to None.

• last_mod_end_date (datetime, optional) – search by modified date. Defaults to None.

• match_criteria_id (str, optional) – specific by UUID. Defaults to None.

Returns:

API Result

Return type:

CpeMatchOas

get_all_cpes(cpe_name_id: str | None = None, cpe_match_string: str | None = None, keyword_exact_match: bool = False, keyword_search: str | None = None, last_mod_start_date: datetime | None = None, last_mod_end_date: datetime | None = None, match_criteria_id: str | None = None) → CpeOas

All CPE API # noqa: E501

Parameters:

• cpe_name_id (str, optional) – specific CPE record UUID. Defaults to None.

• cpe_match_string (str, optional) – CPE Name. Defaults to None.

• keyword_exact_match (bool, optional) – if CPE exactly match or not. Defaults to None. Defaults to False.

• keyword_search (str, optional) – a word or phrase is found in the metadata title or reference links. Defaults to None.

• last_mod_start_date (datetime, optional) – search CPE by modified date. Defaults to None.

• last_mod_end_date (datetime, optional) – search CPE by modified date. Defaults to None.

• match_criteria_id (str, optional) – search CPE by uuid. Defaults to None.

Returns:

API Result

Return type:

CpeOas

get_all_cve_history(change_start_date: datetime | None = None, change_end_date: datetime | None = None, cve_id: str | None = None, event_name: EVENT_NAME | None = None) → CveHistoryOas

All CVE Change History API # noqa: E501

Parameters:

• change_start_date (datetime, optional) – search by changed date. Defaults to None.

• change_end_date (datetime, optional) – search by changed date. Defaults to None.

• cve_id (str, optional) – CVE ID. Defaults to None.

• event_name (EVENT_NAME, optional) – returns all CVE associated with a specific type of change event. Defaults to None.

Returns:

API Result

Return type:

CveHistoryOas

get_all_cves(cpe_name: str | None = None, cve_id: str | None = None, cvss_v2_metrics: str | None = None, cvss_v2_severity: CVSS_V2_SEVERITY | None = None, cvss_v3_metrics: str | None = None, cvss_v3_severity: CVSS_V3_SEVERITY | None = None, cwe_id: str | None = None, has_cert_alerts: bool = False, has_cert_notes: bool = False, has_kev: bool = False, has_oval: bool = False, is_vulnerable: bool = False, keyword_exact_match: bool = False, keyword_search: str | None = None, last_mod_start_date: datetime | None = None, last_mod_end_date: datetime | None = None, no_rejected: bool = False, pub_start_date: datetime | None = None, pub_end_date: datetime | None = None, source_identifier: str | None = None, version_end: str | None = None, version_end_type: VERSION_TYPE | None = None, version_start: str | None = None, version_start_type: VERSION_TYPE | None = None, virtual_match_string: str | None = None) → CveOas

All CVE API # noqa: E501

Parameters:

• cpe_name (str, optional) – CPE Name. Defaults to None.

• cve_id (str, optional) – CVE ID. Defaults to None.

• cvss_v2_metrics (str, optional) – CVSSv2 vector string. Defaults to None.

• cvss_v2_severity (CVSS_V2_SEVERITY, optional) – CVSSv2 qualitative severity rating. Defaults to None.

• cvss_v3_metrics (str, optional) – CVSSv3 vector string. Defaults to None.

• cvss_v3_severity (CVSS_V3_SEVERITY, optional) – CVSSv3 qualitative severity rating. Defaults to None.

• cwe_id (str, optional) – CWE ID. Defaults to None.

• has_cert_alerts (bool, optional) – contain a Technical Alert from US-CERT. Defaults to False.

• has_cert_notes (bool, optional) – contain a Vulnerability Note from CERT/CC. Defaults to False.

• has_kev (bool, optional) – appear in CISA’s Known Exploited Vulnerabilities (KEV) Catalog. Defaults to False.

• has_oval (bool, optional) – contain information from MITRE’s Open Vulnerability and Assessment Language (OVAL). Defaults to False.

• is_vulnerable (bool, optional) – returns only CVE associated with a specific CPE. Defaults to False.

• keyword_exact_match (bool, optional) – returns any CVE where a word or phrase. Defaults to False.

• keyword_search (str, optional) – a word or phrase is found in the current description. Defaults to None.

• last_mod_start_date (datetime, optional) – search by modified date. Defaults to None.

• last_mod_end_date (datetime, optional) – search by modified date. Defaults to None.

• no_rejected (bool, optional) – return the CVE API includes CVE records with the REJECT or Rejected status. Defaults to False.

• pub_start_date (datetime, optional) – search by published date. Defaults to None.

• pub_end_date (datetime, optional) – search by published date. Defaults to None.

• source_identifier (str, optional) – returns CVE where the exact value of sourceIdentifier appears. Defaults to None.

• version_end (str, optional) – return only the CVEs associated with CPEs in specific version ranges. Defaults to None.

• version_end_type (VERSION_TYPE, optional) – return only the CVEs associated with CPEs in specific version ranges. Defaults to None.

• version_start (str, optional) – return only the CVEs associated with CPEs in specific version ranges. Defaults to None.

• version_start_type (VERSION_TYPE, optional) – return only the CVEs associated with CPEs in specific version ranges. Defaults to None.

• virtual_match_string (str, optional) – CVE more broadly than cpeName. Defaults to None.

Returns:

API Result

Return type:

AsyncResult

get_cpe_match(cve_id: str | None = None, last_mod_start_date: datetime | None = None, last_mod_end_date: datetime | None = None, match_criteria_id: str | None = None, results_per_page: int | None = None, start_index: int | None = None) → CpeMatchOas

Match Criteria API # noqa: E501

Parameters:

• cve_id (str, optional) – CVE ID. Defaults to None.

• last_mod_start_date (datetime, optional) – search by modified date. Defaults to None.

• last_mod_end_date (datetime, optional) – search by modified date. Defaults to None.

• match_criteria_id (str, optional) – specific by UUID. Defaults to None.

• results_per_page (int, optional) – max number of records (default is 5000). Defaults to None.

• start_index (int, optional) – the index of the first match string. Defaults to None.

Returns:

API Result

Return type:

CpeMatchOas

get_cpes(cpe_name_id: str | None = None, cpe_match_string: str | None = None, keyword_exact_match: bool = False, keyword_search: str | None = None, last_mod_start_date: datetime | None = None, last_mod_end_date: datetime | None = None, match_criteria_id: str | None = None, results_per_page: int | None = None, start_index: int | None = None) → CpeOas

CPE API # noqa: E501

Parameters:

• cpe_name_id (str, optional) – specific CPE record UUID. Defaults to None.

• cpe_match_string (str, optional) – CPE Name. Defaults to None.

• keyword_exact_match (bool, optional) – if CPE exactly match or not. Defaults to None. Defaults to False.

• keyword_search (str, optional) – a word or phrase is found in the metadata title or reference links. Defaults to None.

• last_mod_start_date (datetime, optional) – search CPE by modified date. Defaults to None.

• last_mod_end_date (datetime, optional) – search CPE by modified date. Defaults to None.

• match_criteria_id (str, optional) – search CPE by uuid. Defaults to None.

• results_per_page (int, optional) – max number of CPE records (default is 10000). Defaults to None.

• start_index (int, optional) – the index of the first match string. Defaults to None.

Returns:

API Result

Return type:

CpeOas

get_cve_history(change_start_date: datetime | None = None, change_end_date: datetime | None = None, cve_id: str | None = None, event_name: EVENT_NAME | None = None, results_per_page: int | None = None, start_index: int | None = None) → CveHistoryOas

CVE Change History API # noqa: E501

Parameters:

• change_start_date (datetime, optional) – search by changed date. Defaults to None.

• change_end_date (datetime, optional) – search by changed date. Defaults to None.

• cve_id (str, optional) – CVE ID. Defaults to None.

• event_name (EVENT_NAME, optional) – returns all CVE associated with a specific type of change event. Defaults to None.

• results_per_page (int, optional) – max number of records (default is 5000). Defaults to None.

• start_index (int, optional) – the index of the first match string. Defaults to None.

Returns:

API Result

Return type:

CveHistoryOas

get_cves(cpe_name: str | None = None, cve_id: str | None = None, cvss_v2_metrics: str | None = None, cvss_v2_severity: CVSS_V2_SEVERITY | None = None, cvss_v3_metrics: str | None = None, cvss_v3_severity: CVSS_V3_SEVERITY | None = None, cwe_id: str | None = None, has_cert_alerts: bool = False, has_cert_notes: bool = False, has_kev: bool = False, has_oval: bool = False, is_vulnerable: bool = False, keyword_exact_match: bool = False, keyword_search: str | None = None, last_mod_start_date: datetime | None = None, last_mod_end_date: datetime | None = None, no_rejected: bool = False, pub_start_date: datetime | None = None, pub_end_date: datetime | None = None, results_per_page: int = 2000, start_index: int | None = None, source_identifier: str | None = None, version_end: str | None = None, version_end_type: VERSION_TYPE | None = None, version_start: str | None = None, version_start_type: VERSION_TYPE | None = None, virtual_match_string: str | None = None) → CveOas

CVE API # noqa: E501

Parameters:

• cpe_name (str, optional) – CPE Name. Defaults to None.

• cve_id (str, optional) – CVE ID. Defaults to None.

• cvss_v2_metrics (str, optional) – CVSSv2 vector string. Defaults to None.

• cvss_v2_severity (CVSS_V2_SEVERITY, optional) – CVSSv2 qualitative severity rating. Defaults to None.

• cvss_v3_metrics (str, optional) – CVSSv3 vector string. Defaults to None.

• cvss_v3_severity (CVSS_V3_SEVERITY, optional) – CVSSv3 qualitative severity rating. Defaults to None.

• cwe_id (str, optional) – CWE ID. Defaults to None.

• has_cert_alerts (bool, optional) – contain a Technical Alert from US-CERT. Defaults to False.

• has_cert_notes (bool, optional) – contain a Vulnerability Note from CERT/CC. Defaults to False.

• has_kev (bool, optional) – appear in CISA’s Known Exploited Vulnerabilities (KEV) Catalog. Defaults to False.

• has_oval (bool, optional) – contain information from MITRE’s Open Vulnerability and Assessment Language (OVAL). Defaults to False.

• is_vulnerable (bool, optional) – returns only CVE associated with a specific CPE. Defaults to False.

• keyword_exact_match (bool, optional) – returns any CVE where a word or phrase. Defaults to False.

• keyword_search (str, optional) – a word or phrase is found in the current description. Defaults to None.

• last_mod_start_date (datetime, optional) – search by modified date. Defaults to None.

• last_mod_end_date (datetime, optional) – search by modified date. Defaults to None.

• no_rejected (bool, optional) – return the CVE API includes CVE records with the REJECT or Rejected status. Defaults to False.

• pub_start_date (datetime, optional) – search by published date. Defaults to None.

• pub_end_date (datetime, optional) – search by published date. Defaults to None.

• results_per_page (int, optional) – max number of records (default is 2000). Defaults to None.

• start_index (int, optional) – the index of the first match string. Defaults to None.

• source_identifier (str, optional) – returns CVE where the exact value of sourceIdentifier appears. Defaults to None.

• version_end (str, optional) – return only the CVEs associated with CPEs in specific version ranges. Defaults to None.

• version_end_type (VERSION_TYPE, optional) – return only the CVEs associated with CPEs in specific version ranges. Defaults to None.

• version_start (str, optional) – return only the CVEs associated with CPEs in specific version ranges. Defaults to None.

• version_start_type (VERSION_TYPE, optional) – return only the CVEs associated with CPEs in specific version ranges. Defaults to None.

• virtual_match_string (str, optional) – CVE more broadly than cpeName. Defaults to None.

Returns:

API Result

Return type:

AsyncResult

update_last_exec_datetime()

class nvd_api.client.VERSION_TYPE(value)

Bases: Enum

CPEs specific version range type

EXCLUDING = 'excluding'

INCLUDING = 'including'

Module contents

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