Qualys API (VM, PC) User Guide

Qualys API (VM, PC)

User Guide Version 10.14

September 24, 2021

Copyright 2018-2021 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................................................................................................................. 8

Chapter 1 - Welcome........................................................................................ 9

API Conventions ...................................................................................................................... 9 Qualys User Account ........................................................................................................ 9

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

Chapter 2 - Authentication to your account .............................................17

What do I need to know? ...................................................................................................... 17 Using Basic HTTP Authentication ....................................................................................... 17 Using Session Based Authentication ................................................................................... 18 Session Login .......................................................................................................................... 21 Session Logout ....................................................................................................................... 23

Chapter 3 - Scans............................................................................................25

VM Scans ................................................................................................................................ 26 VM Scan List .................................................................................................................... 26 Launch VM Scan ............................................................................................................. 29 Launch VM Scan on EC2 assets ..................................................................................... 31 Manage VM Scans ........................................................................................................... 34

Compliance Scans ................................................................................................................. 36 Compliance Scan List ..................................................................................................... 37 SCAP Scan List ................................................................................................................. 38 Launch Compliance Scan ............................................................................................... 40 Launch Compliance Scan on EC2 assets ...................................................................... 41 Manage Compliance Scans ............................................................................................ 43

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

VM Scan Schedules ............................................................................................................... 49 PC Scan Schedules ................................................................................................................. 60 Scan List Parameters ............................................................................................................. 70 Scan Parameters .................................................................................................................... 72 Cloud Perimeter Scan Parameters ....................................................................................... 77 Scan Schedule Parameters ................................................................................................... 80 VM Scan Statistics ................................................................................................................. 85 VM Scan Summary ................................................................................................................ 88

Scanner Details ...................................................................................................................... 91 Share PCI Scan ....................................................................................................................... 93 Discovery Scans (maps) ........................................................................................................ 97

Chapter 4 - Scan Configuration ................................................................ 106

Scanner Appliance List ....................................................................................................... 107 Manage Virtual Scanner Appliances ................................................................................. 112 Update Physical Scanner Appliance .................................................................................. 117 Replace Scanner Appliance ................................................................................................ 120 Scanner Appliance VLANs and Static Routes ................................................................... 122 Option Profile Export ........................................................................................................... 127 Option Profile Import .......................................................................................................... 137 Option Profiles for VM ......................................................................................................... 143 Option Profiles for PCI ......................................................................................................... 158 Option Profiles for Compliance .......................................................................................... 167 KnowledgeBase .................................................................................................................... 189 Editing Vulnerabilities ......................................................................................................... 194 Static Search Lists ................................................................................................................ 197 Dynamic Search Lists .......................................................................................................... 202 Vendor IDs and References ................................................................................................ 213

Chapter 5 - Scan Authentication............................................................... 216

User Permissions Summary ............................................................................................... 217 List Authentication Records ............................................................................................... 218 List Authentication Records by Type ................................................................................ 220 Application Server Records ................................................................................................. 224 Azure MS SQL Record .......................................................................................................... 229 Docker Record ...................................................................................................................... 234 HTTP Record ......................................................................................................................... 237 IBM DB2 Record .................................................................................................................... 240 InformixDB Record .............................................................................................................. 244 JBoss Server record .............................................................................................................. 249 Kubernetes Record ............................................................................................................... 253 MariaDB Record ................................................................................................................... 256 Microsoft SharePoint Record .............................................................................................. 260 MongoDB Record .................................................................................................................. 270 MS Exchange Server ............................................................................................................ 276 MS SQL Record ..................................................................................................................... 281 MySQL Record ...................................................................................................................... 290 Neo4j Record ........................................................................................................................ 297 Nginx Record ........................................................................................................................ 302 Oracle Record ....................................................................................................................... 306

System created Oracle records .................................................................................... 311 Oracle Listener Record ........................................................................................................ 314

Oracle WebLogic Server Record ......................................................................................... 316 Palo Alto Firewall Record .................................................................................................... 319 Pivotal Greenplum Record .................................................................................................. 323 PostgreSQL Record ............................................................................................................... 330 SAP Hana Record ................................................................................................................. 337 SAP IQ Record ...................................................................................................................... 342 SNMP Record ........................................................................................................................ 347 Sybase Record ...................................................................................................................... 352 Unix Record .......................................................................................................................... 358 Network SSH Record ........................................................................................................... 370 VMware Record .................................................................................................................... 375 Windows Record .................................................................................................................. 378 Oracle HTTP Server Record ................................................................................................ 386 vCenter - ESXi Mapping Records ........................................................................................ 396

Chapter 6 - Vault Support ......................................................................... 402

Vault Support matrix .......................................................................................................... 402 Vault Definition ................................................................................................................... 408 List Vaults ............................................................................................................................. 415 Manage Vaults ..................................................................................................................... 418

Chapter 7 - Assets ....................................................................................... 429

IP List ..................................................................................................................................... 430 Add IPs .................................................................................................................................. 433 Update IPs ............................................................................................................................. 435 Host List ................................................................................................................................ 439 Host Update ......................................................................................................................... 449 Host List Detection .............................................................................................................. 453 Host List Detection - Normalized Data ............................................................................. 472 Host List Detection - Use Cases ......................................................................................... 473 Host List Detection - Best Practices ................................................................................... 474 Excluded Host List ............................................................................................................... 475 Excluded Hosts Change History ......................................................................................... 478 Manage Excluded Hosts ...................................................................................................... 481 Virtual Host List ................................................................................................................... 485 Manage Virtual Hosts .......................................................................................................... 486 Restricted IPs List ................................................................................................................ 488 Manage Restricted IPs ......................................................................................................... 490 Asset Group List ................................................................................................................... 493 Manage Asset Groups .......................................................................................................... 496 Purge Hosts ........................................................................................................................... 501 Patch List .............................................................................................................................. 508

Chapter 8 - IPv6 Assets............................................................................... 510

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

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

Google Online Preview   Download