Qualys API (VM, PC) User Guide

Qualys API (VM, PC)

User Guide Version 10.22.3

June 07, 2023

Copyright 2018-2023 by Qualys, Inc. All Rights Reserved.

Qualys and the Qualys logo are registered trademarks of Qualys, Inc. All other trademarks are the property of their respective owners.

Qualys, Inc. 919 E Hillsdale Blvd 4th Floor Foster City, CA 94404 1 (650) 801 6100

Table of Contents

Preface................................................................................................................. 9

Welcome ........................................................................................................... 10

API Conventions .................................................................................................................... 10 Qualys User Account ...................................................................................................... 10

Qualys API Server URL .......................................................................................................... 11 Making API requests .............................................................................................................. 12 API Limits ............................................................................................................................... 13 Tracking API usage by user .................................................................................................. 14 HTTP Response Headers ....................................................................................................... 14 Activity Log ............................................................................................................................. 17

Authentication to your account ...................................................................18

What do I need to know? ...................................................................................................... 18 Using Basic HTTP Authentication ....................................................................................... 18 Using Session Based Authentication ................................................................................... 19 Session Login .......................................................................................................................... 22 Session Logout ....................................................................................................................... 24

Scans ..................................................................................................................26

VM Scans ................................................................................................................................ 27 VM Scan List .................................................................................................................... 27 List Last `N' Scan References for a Schedule ............................................................... 30 Launch VM Scan ............................................................................................................. 33 Launch VM Scan on EC2 assets ..................................................................................... 35 Manage VM Scans ........................................................................................................... 38

Compliance Scans ................................................................................................................. 41 Compliance Scan List ..................................................................................................... 42 List Last `N' Scan References for a Schedule ............................................................... 43 SCAP Scan List ................................................................................................................. 46 Launch Compliance Scan ............................................................................................... 48 Launch Compliance Scan on EC2 assets ...................................................................... 49 Manage Compliance Scans ............................................................................................ 51

Cloud Perimeter Scans .......................................................................................................... 54 Create/Update Cloud Perimeter Scan ........................................................................... 54

VM Scan Schedules ............................................................................................................... 57 PC Scan Schedules ................................................................................................................. 68 Scan List Parameters ............................................................................................................. 78 Scan Parameters .................................................................................................................... 80 Cloud Perimeter Scan Parameters ....................................................................................... 85 Scan Schedule Parameters ................................................................................................... 89

VM Scan Statistics ................................................................................................................. 93 VM Scan Summary ................................................................................................................ 96 Scan Summary ..................................................................................................................... 107 Scanner Details .................................................................................................................... 110 Share PCI Scan ..................................................................................................................... 112 Discovery Scans (maps) ...................................................................................................... 116

Scan Configuration....................................................................................... 125

Scanner Appliance List ....................................................................................................... 126 Manage Virtual Scanner Appliances ................................................................................. 131 Update Physical Scanner Appliance .................................................................................. 137 Replace Scanner Appliance ................................................................................................ 140 Scanner Appliance VLANs and Static Routes ................................................................... 142 Option Profile Export ........................................................................................................... 147 Option Profile Import .......................................................................................................... 157 Option Profiles for VM ......................................................................................................... 164 Option Profiles for PCI ......................................................................................................... 179 Option Profiles for Compliance .......................................................................................... 187 KnowledgeBase .................................................................................................................... 209 KnowledgeBase QVS Download in JSON Format .............................................................. 215 Editing Vulnerabilities ......................................................................................................... 217 Static Search Lists ................................................................................................................ 220 Dynamic Search Lists .......................................................................................................... 225 Vendor IDs and References ................................................................................................ 236

Scan Authentication.................................................................................... 240

User Permissions Summary ............................................................................................... 241 List Authentication Records ............................................................................................... 242 List Authentication Records by Type ................................................................................ 244 Application Server Records ................................................................................................. 249 Azure MS SQL Record .......................................................................................................... 254 Docker Record ...................................................................................................................... 259 HTTP Record ......................................................................................................................... 262 IBM DB2 Record .................................................................................................................... 265 InformixDB Record .............................................................................................................. 270 Infoblox Record .................................................................................................................... 275 JBoss Server record .............................................................................................................. 281 Kubernetes Record ............................................................................................................... 285 MariaDB Record ................................................................................................................... 288 Microsoft SharePoint Record .............................................................................................. 292 MongoDB Record .................................................................................................................. 302

System created MongoDB records ............................................................................... 305 MS Exchange Server ............................................................................................................ 312 MS SQL Record ..................................................................................................................... 317

MySQL Record ...................................................................................................................... 326 Neo4j Record ........................................................................................................................ 333 Nginx Record ........................................................................................................................ 338 Oracle Record ....................................................................................................................... 342

System created Oracle records .................................................................................... 347 Oracle Listener Record ........................................................................................................ 350 Oracle WebLogic Server Record ......................................................................................... 352 Palo Alto Firewall Record .................................................................................................... 355 Pivotal Greenplum Record .................................................................................................. 359 PostgreSQL Record ............................................................................................................... 366 SAP Hana Record ................................................................................................................. 373 SAP IQ Record ...................................................................................................................... 378 SNMP Record ........................................................................................................................ 383 Sybase Record ...................................................................................................................... 388 Unix Record .......................................................................................................................... 394 Network SSH Record ........................................................................................................... 409 VMware Record .................................................................................................................... 414 Windows Record .................................................................................................................. 419 Oracle HTTP Server Record ................................................................................................ 427 vCenter - ESXi Mapping Records ........................................................................................ 437

Vault Support................................................................................................ 443

Vault Support matrix .......................................................................................................... 443 Vault Definition ................................................................................................................... 449 List Vaults ............................................................................................................................. 456 Manage Vaults ..................................................................................................................... 459

Assets.............................................................................................................. 470

IP List ..................................................................................................................................... 471 Add IPs .................................................................................................................................. 474 Update IPs ............................................................................................................................. 476 Host List ................................................................................................................................ 480 Host Update ......................................................................................................................... 492 Host List Detection .............................................................................................................. 496 Host List Detection - Normalized Data ............................................................................. 518 Host List Detection - Use Cases ......................................................................................... 518 Host List Detection - Best Practices ................................................................................... 520 Excluded Host List ............................................................................................................... 520 Excluded Hosts Change History ......................................................................................... 523 Manage Excluded Hosts ...................................................................................................... 526 Virtual Host List ................................................................................................................... 530 Manage Virtual Hosts .......................................................................................................... 531 Restricted IPs List ................................................................................................................ 534 Manage Restricted IPs ......................................................................................................... 535

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download