Reporting Toolbox: Creating Dynamic Search Lists via APIv2

Document created by DMFezzaReed Employee on Aug 20, 2018
Version 1Show Document
  • View in full screen mode

Creating Dynamic Search Lists via APIv2

Please refer to the most current version of the Qualys API v2 Guide in Documentation | Qualys, Inc.  for the most accurate criteria available within the API.

I use cURL commands to share API opptions, as cURL is my go-to tool for a quick 1-2-3 solution to a non-routine, non-repeating activity.  You are free to choose whichever tool or methodology that works best for you. 

 

I highly recommend visiting Questions for Jeff Leggett here in our community blog, as well as Qualys @ GitHub.

 

What API Server URL to use Qualys maintains multiple Qualys platforms. The Qualys API server URL that you should use for API requests depends on the platform where your account is located.

 

Qualys US Platform 1 https://qualysapi.qualys.com

Qualys US Platform 2 https://qualysapi.qg2.apps.qualys.com

Qualys US Platform 3 https://qualysapi.qg3.apps.qualys.com

Qualys EU Platform 1 https://qualysapi.qualys.eu

Qualys EU Platform 2 https://qualysapi.qg2.apps.qualys.eu

Qualys India Platform 1 https://qualysapi.qg1.apps.qualys.in

Qualys Private Cloud Platform https://qualysapi.

 

Create Dynamic Search List:

 

curl -H "X-Requested-With: Curl Basic Selection Options" -u "userid:passwd" "https://qualysapi.qualys.com/api/2.0/fo/qid/search_list/dynamic/?action=create& echo_request=1&[Criteria for Dynamic Search List]"

 

Criteria for Dynamic Search List:

 

title={value}&global={0|1}&comments={value}&vuln_title={value}&not_vuln_title={0|1}&discovery_methods={value}&auth_types={value}&user_configuration={value}&categories={value}&not_categories={0|1}&confirmed_severities={value}&potential_vulnerabilities={value}&ig_severities={value}&vendor_ids={value}&not_vendor_ids={0|1}&products={value}&not_products={0|1}&cvss_base={value}&cvss_base_operand={1|2}&cvss_temp={value}&cvss_temp_operand={1|2}&cvss_access_vector={value}&cvss3_base={value}&cvss3_base_operand={1|2}&cvss3_temp={value}&cvss3_temp_operand={1|2}&cvss_access_vector={value}&patch_available={0|1}&virtual_patch_available={0|1}&cve_ids={value}&not_cve_ids={0|1}&exploitability={value}&malware_associated={value}&vendor_refs={value}&not_vendor_refs={0|1}&bugtraq_id={value}&not_bugtraq_id={0|1}&vuln_details={value}&compliance_details={value}&compliance_types={value}&qualys_top_lists={value}&qids_not_exploitable={0|1}&non_running_services={0|1}&sans_20={0|1}&nac_nam={0|1}&vuln_provider={0|1}&user_modified_date_between={value}&user_modified_date_today={0|1}&user_modified_date_in_previous={value}&user_modified_date_within_last_days={value}&not_user_modified={0|1}&service_modified_date_between={value}&service_modified_date_today={0|1}&service_modified_date_in_previous={value}&service_modified_date_within_last_days={value}&not_service_modified={0|1}&published_date_between={value}&published_date_today={0|1}&published_date_in_previous={value}&published_date_within_last_days={value}&not_published={0|1}&supported_modules={value}&

 

Examples

 

Confirmed, Severity 5, No Patch Available

curl -u “USERID:PASSWORD" -H "X-Requested-With:Curl” -X "POST" "https://qualysapi.qualys.com/api/2.0/fo/qid/search_list/dynamic/?action=create&echo_request=1&title=Confirmed-Sev5-No_Patch_Available&global=1&confirmed_severities=5&patch_available=0"

 

 

 

 

 

 

Confirmed, Severity 5, Patchable Vulnerabilities

curl -u “USERID:PASSWORD" -H "X-Requested-With:Curl” -X "POST" "https://qualysapi.qualys.com/api/2.0/fo/qid/search_list/dynamic/?action=create&echo_request=1&title=Confirmed-Sev5-Patch_Available&global=1&confirmed_severities=5&patch_available=1"

 

 

 

 

 

 

reporting_toolbox

 

 

 

Back to Dashboarding and Reporting 

Attachments

    Outcomes