From 9f8d99651a345ca29b095151dda213808becdaca Mon Sep 17 00:00:00 2001 From: Jakob Lindsay <89279733+0x41424142@users.noreply.github.com> Date: Thu, 3 Oct 2024 23:02:25 +0000 Subject: [PATCH 1/2] Updated docs --- docs/totalcloud.md | 4 ++-- docs/vmdr.md | 1 + docs/was.md | 2 +- qualysdk/base/call_schema.py | 3 +-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/totalcloud.md b/docs/totalcloud.md index 957dbdb..9592a3d 100644 --- a/docs/totalcloud.md +++ b/docs/totalcloud.md @@ -120,7 +120,7 @@ print(dumps(get_aws_base_account(auth), indent=2)) #### ```filter``` Search Tokens ->>**Head's Up!:** When using ```resource.type``` as the filter, you must use the API-expected name. See **```resourceType``` Values** table for expected names. +>**Head's Up!:** When using ```resource.type``` as the filter, you must use the API-expected name. See **```resourceType``` Values** table for expected names. |Token| Description | |--|--| @@ -159,7 +159,7 @@ get_control_metadata(auth, filter='resource.type:BUCKET') This function takes advantage of multithreading to pull down data faster. You can specify the number of threads with the ```thread_count``` argument, which defaults to 5. ->>**Head's Up!:** At maximum, this API endpoint returns 10,000 records. This is a hard limit imposed by Qualys. If you have more than 10K records under a single ```resourceType```, you will need to use the ```filter``` argument to narrow down the results and make repeated calls to get all the data. An easy way to do this is to use ```totalcloud.get_connectors()```, then use the connector's account ID (```subscriptionId``` for Azure) attribute in this API call's ```filter``` argument, storing the results in a ```BaseList```. For example: +>**Head's Up!:** At maximum, this API endpoint returns 10,000 records. This is a hard limit imposed by Qualys. If you have more than 10K records under a single ```resourceType```, you will need to use the ```filter``` argument to narrow down the results and make repeated calls to get all the data. An easy way to do this is to use ```totalcloud.get_connectors()```, then use the connector's account ID (```subscriptionId``` for Azure) attribute in this API call's ```filter``` argument, storing the results in a ```BaseList```. For example: ```py from qualysdk import BaseList diff --git a/docs/vmdr.md b/docs/vmdr.md index eb07f60..18c4382 100644 --- a/docs/vmdr.md +++ b/docs/vmdr.md @@ -68,6 +68,7 @@ Some important kwargs this API accepts: |```ids```|```None/hostIDs```|Filter API output to a specific set of host IDs. Can be a comma-separated string: ```1357,2468,8901```, a range: ```12345-54321```, or a single host ID: ```12345```.| >**Heads Up!**: For a full breakdown of acceptable kwargs, see Qualys' documentation [here](https://cdn2.qualys.com/docs/qualys-api-vmpc-user-guide.pdf). + ```py from qualysdk import BasicAuth from qualysdk.vmdr import get_hld diff --git a/docs/was.md b/docs/was.md index ffad6bf..7d77ec6 100644 --- a/docs/was.md +++ b/docs/was.md @@ -22,7 +22,7 @@ You can use any of the endpoints currently supported: ```count_webapps``` returns the number of web apps in the subscription that match the given kwargs. ->>**Head's Up!** This method is useful for quickly getting a count of webapps that match a certain criteria. It does NOT return the webapps themselves, or any attributes of the webapps. +>**Head's Up!** This method is useful for quickly getting a count of webapps that match a certain criteria. It does NOT return the webapps themselves, or any attributes of the webapps. |Parameter| Possible Values |Description| Required| |--|--|--|--| diff --git a/qualysdk/base/call_schema.py b/qualysdk/base/call_schema.py index 5bfc941..766b23b 100644 --- a/qualysdk/base/call_schema.py +++ b/qualysdk/base/call_schema.py @@ -434,8 +434,7 @@ "default_scanner", "scanners_in_ag", "scanners_in_network", # set to 1 to use all scanners - "target_from" # must be tags - "use_ip_nt_range_tags_include", + "target_from" "use_ip_nt_range_tags_include", # must be tags "use_ip_nt_range_tags_exclude", "use_ip_nt_range_tags", "tag_include_selector", From f5438219521758d7f690bb5ae76e378d01b64893 Mon Sep 17 00:00:00 2001 From: Jakob Lindsay <89279733+0x41424142@users.noreply.github.com> Date: Thu, 3 Oct 2024 19:17:27 -0400 Subject: [PATCH 2/2] Update call_schema.py --- qualysdk/base/call_schema.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/qualysdk/base/call_schema.py b/qualysdk/base/call_schema.py index 766b23b..aa71e20 100644 --- a/qualysdk/base/call_schema.py +++ b/qualysdk/base/call_schema.py @@ -434,7 +434,8 @@ "default_scanner", "scanners_in_ag", "scanners_in_network", # set to 1 to use all scanners - "target_from" "use_ip_nt_range_tags_include", # must be tags + "target_from", + "use_ip_nt_range_tags_include", # must be tags "use_ip_nt_range_tags_exclude", "use_ip_nt_range_tags", "tag_include_selector",