qualysdk - A Python SDK for Interacting With Qualys APIs
This SDK attempts to make it much easier to interact with Qualys's various API endpoints, across as many modules as I can find time to code.
Uber Class Example
from qualysdk import TokenAuth, GAVUber
auth = TokenAuth(<username>, <password>, platform='qg1')
uber = GAVUber(auth)
assets = uber.get(
"query_assets",
filter='operatingSystem:"Linux"',
lastModifiedDate="2024-06-21"
)
>>>[AssetID(012345678), ...]
Non-Uber Class Example
from qualysdk.auth import BasicAuth
from qualysdk.vmdr import get_host_list
auth = BasicAuth(<username>, <password>, platform='qg1')
#Pull 4 pages of hosts, with "All/AGs" details & tags:
hosts = get_host_list(auth, details="All/AGs", show_tags=True, page_count=4)
>>>[VMDRHost(12345), ...]
Current Supported Modules
Head's Up!: SQL DB uploading is currently in development! 🎉
| Module | Status |
|---|---|
| GAV (Global AssetView) | ✅ |
| VMDR | In Progress (query_kb, get_host_list, get_hld, get_ag_list, add/edit/remove_ag, get_ip_list, add/update_ips, get_scan_list, pause_scan, cancel_scan, resume_scan, delete_scan, launch_scan, fetch_scan, get_scanner_list, get_static_searchlists, get_report_list, launch/cancel/fetch/delete_report, get_template_list, get_scheduled_report_list, launch_scheduled_report, get_user_list, add/edit_user implemented) |
| PM (Patch Management) | Not Started |
| WAS | In Planning |
| TC (TotalCloud) | Started |
| Connectors | Not Started |
| Cloud Agent | Not Started |
| CS (Container Security) | Not Started |
| ADMIN (Administration) | Not Started |
| Tagging | Not Started |
Documentation/Get Started
For more detailed information on the package, including how to get up and running, please see the documentation.
Disclaimer
This SDK tool is an independent project and is not an official product of Qualys. It has been developed and maintained solely by the names listed in the GitHub contributors list. Qualys has neither endorsed nor approved this SDK.
Users of this SDK are advised to use it at their own risk and discretion.
For official tools and support, please refer to the official Qualys resources and documentation.
TODO:
-
Continue adding VMDR APIs.
-
Start work on TotalCloud/WAS modules.
-
Continue SQL integration.
1 maintainer
Release files for qualysdk 0.1.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| qualysdk-0.1.5.tar.gz | 66.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qualysdk-0.1.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 158.6 kB
Release files / qualysdk-0.1.5.tar.gz
| Download URL | qualysdk-0.1.5.tar.gz |
|---|---|
| Size | 66.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
00f10a189254d80d99f03aa26569e1617dcea2941472659cca7d8a89d279e3d7
|
|
BLAKE2b-256 checksum How to use checksums |
c5cbebcabd3b362cb3a364e87d86dba773d5d288571e8b79605cf8bcb380f18a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.5
|
Release files / qualysdk-0.1.5-py3-none-any.whl
| Download URL | qualysdk-0.1.5-py3-none-any.whl |
|---|---|
| Size | 92.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
33de01ac3318893c5533d45caba72e92040f39e26a8ab8c27606fc03bd9cde03
|
|
BLAKE2b-256 checksum How to use checksums |
f75ce91e58411b9fcad0cd3790a6f29866eed98adfede09a0d769d2b4fc780db
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.5
|
