Skip to main content

Outline

About this document

This document provides step-by-step instructions to configure the Qualys VMDR integration in SAFE and pull assets and vulnerability findings from Qualys Vulnerability Management, Detection and Response (VMDR), enriched with asset context from Qualys CSAM or Global AssetView (GAV).

Introduction

The SAFE Qualys VMDR connector  pulls asset inventory and vulnerability data from Qualys VMDR. It enriches each VMDR host with hardware, software, network, cloud and lifecycle context from Qualys CSAM when available, or from Global AssetView (GAV) when CSAM is unavailable.

What SAFE Pulls from Qualys VMDR

Category Details
Assets Fetched Infrastructure assets reported by the VMDR Host List, including servers, desktops, laptops, virtual machines, cloud instances and network/security nodes.
Data Fetched Qualys asset ID, host name, FQDN, DNS and NetBIOS names, IP address, OS and Qualys tags. When CSAM or GAV context is available, SAFE also pulls network interfaces, hardware details (serial number, manufacturer, model, CPU, memory), cloud metadata (such as AWS account, region and instance ID), open ports, users, services and location.
Software Fetched Installed software from CSAM or GAV context. CSAM gives the richest detail: vendor, install path, install date and ignored flag where present. GAV can provide software names and versions in supported tenants.
Findings Fetched Vulnerability findings from VMDR Host List Detection joined with Qualys KnowledgeBase details: QID and title; CVE identifiers; Qualys severity and QDS severity; CVSS scores; detection type (Confirmed or Potential); status (New, Active, Re-Opened or Fixed); first and last detected timestamps; port, protocol and SSL flag; threat, impact, diagnosis and remediation guidance; risk accepted / ignored or disabled flags. Fields are included where available.
Out of Scope EASM-only assets, EASM vulnerabilities, Policy Compliance / SCA configuration checks, EDR alerts, and standalone CSAM assets not present in VMDR.

Prerequisites

  1. A Qualys VMDR subscription with access to the Host List, Host List Detection and KnowledgeBase APIs.
  2. A Qualys administrator account to create the integration user and assign it to all asset groups, business units, networks or tags SAFE should sync.
  3. SAFE admin access.
  4. Outbound HTTPS from SAFE to the Qualys API Server (for example https://qualysapi.<pod>.apps.qualys.com). If the customer restricts access by source IP, allowlist the SAFE egress IPs first.
  5. (Optional) For richer software and asset context, either:
    • CSAM: the API Gateway URL (for example https://gateway.<pod>.apps.qualys.com) and CSAM / Global AssetView API access, or
    • GAV: Asset Management access for the Host Asset search.If neither is available, SAFE syncs VMDR assets and vulnerabilities only, with no software.

Minimum privileges

Scope / Permission Required? Why it is needed
API access Yes Allows SAFE to authenticate and call Qualys APIs over HTTPS.
VMDR Host List Yes Fetches host inventory, host details, tags and asset IDs.
Host List Detection Yes Fetches host vulnerability detections.
KnowledgeBase Yes Fetches QID details, CVE mappings, severity, diagnosis, consequence and remediation.
Scoped assets Yes The user must be assigned to all asset groups, business units, networks or tags that SAFE should sync.
Asset Management and Tagging Only when a tag filter is configured Resolves tag names to tag IDs.
Global AssetView Host Asset search Recommended Fallback context: software, interfaces, hardware basics, open ports and cloud identity.
CSAM / API Gateway access Optional, recommended when CSAM is licensed Richer context: software vendor, install path, OS details, location and improved software-to-finding linkage.

Generate connection details

You need the following from the customer's Qualys environment: the API Server URL, the Username and Password of a dedicated API user, and optionally the API Gateway URL, a Tag Filter and an Asset last seen days filter.

Confirm the Qualys platform URLs

  1. Identify the customer's Qualys platform / pod. Common URL patterns are:
    • Qualys portal: https://qualysguard.<pod>.apps.qualys.com
    • API Server: https://qualysapi.<pod>.apps.qualys.com
    • API Gateway: https://gateway.<pod>.apps.qualys.com
  2. Confirm the exact API Server URL from the customer's Qualys documentation or subscription details. The Qualys Platform Identification page also lists the correct URLs for each pod (see API URLs below).
  3. If the customer has CSAM and wants richer context, confirm the API Gateway URL as well.

Create a dedicated SAFE integration user

  1. Log in to the Qualys platform with an administrator account.
  2. Go to the user administration area. In many Qualys tenants this is under Administration or Users.
  3. Create a new user for the SAFE integration, for example safe-qualys-vmdr-api.
  4. Set a strong password and store it securely.
  5. Enable API access for the user (under Allow access to, select API).
  6. Assign the user only to the asset groups, tags, business units, networks or scopes that SAFE should ingest.
  7. Assign the user a role with Reader or higher access.

Note: Use a dedicated integration user rather than a named administrator account, and grant read-only access wherever possible. Rotate the password periodically (see the FAQ).

Assign the required VMDR permissions

SAFE needs the permissions below. Missing VMDR Host List, Host List Detection or KnowledgeBase access can cause Test Connection or Sync to fail.

  1. Read VMDR host inventory through the Host List API.
  2. Read Host List Detection / vulnerability detections.
  3. Read KnowledgeBase vulnerability details.
  4. Do not grant write, remediation, scan launch or asset management modification permissions unless the customer's internal process requires them for unrelated use cases.

Assign tag and context permissions, if applicable

  1. Tag filter: if the connector uses a tag filter, grant Asset Management and Tagging access so SAFE can resolve tag names to tag IDs.
    • Go to Role Management within the Administration utility to check or create a custom role.
    • Ensure the role includes the necessary Tagging Permissions (such as Create User Tag, Edit User Tag, Delete User Tag or Modify Dynamic Tag Rules, depending on the level of control needed).
    • Ensure asset management permissions (such as Read Asset or Update Asset) are active in the role.
  2. GAV context: grant Asset Management access for Host Asset search.
  3. CSAM context: ensure the user has CSAM / Global AssetView API access, access through the Qualys API Gateway, and App API Enabled (or equivalent API enablement in the customer's Qualys subscription).
  4. Confirm the user's asset scope includes all hosts that SAFE should sync.

Note: A missing CSAM or GAV permission does not necessarily fail the connector. SAFE falls back to the next available context source.

API URLs

Use the API Gateway URL for Asset Inventory (CSAM context). Use the API Server URL for everything else in this connector. Customers can confirm their pod and URLs on the official Qualys Platform Identification page.

Platform API Server URL API Gateway URL
US1 https://qualysapi.qualys.com https://gateway.qg1.apps.qualys.com
US2 https://qualysapi.qg2.apps.qualys.com https://gateway.qg2.apps.qualys.com
US3 https://qualysapi.qg3.apps.qualys.com https://gateway.qg3.apps.qualys.com
US4 https://qualysapi.qg4.apps.qualys.com https://gateway.qg4.apps.qualys.com
GOV1 https://qualysapi.gov1.qualys.us https://gateway.gov1.qualys.us
EU1 https://qualysapi.qualys.eu https://gateway.qg1.apps.qualys.eu
EU2 https://qualysapi.qg2.apps.qualys.eu https://gateway.qg2.apps.qualys.eu
EU3 https://qualysapi.qg3.apps.qualys.it https://gateway.qg3.apps.qualys.it
IN1 https://qualysapi.qg1.apps.qualys.in https://gateway.qg1.apps.qualys.in
CA1 https://qualysapi.qg1.apps.qualys.ca https://gateway.qg1.apps.qualys.ca
AE1 https://qualysapi.qg1.apps.qualys.ae https://gateway.qg1.apps.qualys.ae
UK1 https://qualysapi.qg1.apps.qualys.co.uk https://gateway.qg1.apps.qualys.co.uk
AU1 https://qualysapi.qg1.apps.qualys.com.au https://gateway.qg1.apps.qualys.com.au
KSA1 https://qualysapi.qg1.apps.qualysksa.com https://gateway.qg1.apps.qualysksa.com
Private Platforms https://qualysapi.<customer_base_url> https://qualysgateway.<customer_base_url>

Configure in SAFE

  1. Sign in to SAFE as an admin and go to Integrations.
  2. Select the Qualys VMDR card.
  3. Enter a unique Integration Name (mandatory).
  4. Enter the API Server URL.
  5. (Optional) Enter the API Gateway URL if CSAM context is licensed and should be attempted.
  6. Enter the Username and Password of the dedicated integration user.
  7. (Optional) Enter a Tag Filter as comma-separated tag names or tag IDs.
  8. Review the Asset last seen days filter. The default is 30. Increase it if the customer has valid hosts with older scan timestamps.
  9. Enter the Auto Sync (in Days) interval at which SAFE runs a sync automatically. The default is 1.
  10. Click Test Connection and confirm that it succeeds.
  11. Once the connection is verified, click Save.
  12. Click Sync Now to run the first sync, and monitor the sync status until it completes.
  13. Validate a sample of synced assets in SAFE. Confirm host name, IP address, OS, tags and vulnerability findings. If CSAM or GAV context is available, also validate software inventory, network interfaces, cloud identifiers, hardware attributes and open ports where present in Qualys.

Configuration notes

  • API Gateway URL: If it is set and CSAM is available, SAFE uses CSAM context. Otherwise SAFE tries GAV. If neither is available, only VMDR assets and vulnerabilities are synced.
  • Tag Filter: Only assets with at least one matching tag are synced. Verify that the tag names resolve exactly in Qualys. If none of the configured tag names or IDs resolve, SAFE fails closed rather than syncing all assets.
  • Asset last seen days filter: Hosts older than this many days are excluded as stale. Hosts with no scan date are kept. Increase the value if valid assets are scanned less often than every 30 days.
  • Software: Software is synced only when CSAM or GAV returns context for the VMDR asset ID.

View Result

To view the assets and the findings:

  1. From the SAFE Integrations page, click on the Qualys VMDR card.
  2. A page with "Finding View" and "Asset View" tabs will open up.
  3. Asset View will list the hosts pulled or updated from Qualys VMDR, one device per VMDR host.
  4. Open an asset to check its host name, IP address, OS and tags. When CSAM or GAV context is available, it also shows software, network interfaces, cloud identifiers, hardware attributes and open ports.
  5. Finding View will list the vulnerability findings from VMDR Host List Detection, with QID, CVE, severity, detection type and status.

API Details

The Qualys VMDR connector pulls data from Qualys over outbound HTTPS. API Server calls use HTTP Basic authentication. API Gateway calls for CSAM use a JWT bearer token obtained from /auth. The POST calls below are search and list requests; SAFE does not write to Qualys.

API Method Endpoint Purpose
VMDR Host List GET {api_server}/api/5.0/fo/asset/host/ Primary asset source. Fetches VMDR hosts, host details, asset IDs and tags.
Host List Detection GET {api_server}/api/5.0/fo/asset/host/vm/detection/ Fetches vulnerability detections for VMDR hosts.
KnowledgeBase POST {api_server}/api/4.0/fo/knowledge_base/vuln/ Fetches QID details, CVE mappings, remediation and vulnerability metadata.
QPS tag search POST {api_server}/qps/rest/2.0/search/am/tag Resolves configured tag names to tag IDs.
GAV host asset search POST {api_server}/qps/rest/2.0/search/am/hostasset Fallback context for software, interfaces, open ports, hardware basics and cloud metadata.
Gateway authentication POST {gateway}/auth Obtains a JWT token for CSAM API Gateway calls.
CSAM asset search POST {gateway}/rest/2.0/search/am/asset Preferred context source when CSAM is available.

FAQs

Q: How frequently does SAFE sync data from Qualys VMDR?

A: Sync frequency depends on the Auto Sync configuration. The default is every 1 day. You can also trigger an on-demand sync at any time using Sync Now.

Q: Does SAFE need write permissions in Qualys?

A: No. The integration is read-only.

Q: Can we use an existing Qualys admin account?

A: It may work if the account has the required permissions. SAFE recommends a dedicated integration user with least-privilege access so access can be audited, rotated and revoked independently.

Q: Is CSAM required?

A: No. VMDR access is required. CSAM is optional and provides richer context. If CSAM is unavailable, SAFE attempts Global AssetView. If neither is available, SAFE syncs VMDR assets and vulnerabilities only.

Q: Are CSAM-only assets imported?

A: No. The connector imports only assets reported by the VMDR Host List. CSAM and GAV enrich those VMDR assets by Qualys asset ID.

Q: Is EASM data imported?

A: No. EASM-only assets and EASM vulnerabilities are out of scope for this connector.

Q: Why are software details missing for some assets?

A: Software is available only when CSAM or GAV returns context for the VMDR asset ID. Some VMDR hosts may not have a Qualys asset ID or may not have context available. If no context source is available at all, configure the API Gateway URL for CSAM or grant GAV Host Asset access.

Q: Test Connection fails with 401 / 403.

A: Likely causes are invalid credentials, API access disabled, a missing permission or insufficient asset scope. Verify the username and password, API access, VMDR permissions and the asset group / tag scope. A 401 or 403 on a VMDR, Detection or KnowledgeBase test means the corresponding required permission is missing or the user is outside the required asset scope.

Q: Test Connection succeeds, but the context says "none".

A: The CSAM and GAV context APIs are unavailable or not permitted. Grant GAV or CSAM / API Gateway access if software and enriched context are required.

Q: Zero assets were synced.

A: Possible causes are a tag filter that resolves to no tags, an API user with limited scope, the wrong Qualys pod, or a last-seen filter that excludes the hosts. Check the tag names or IDs, the asset scope, the API Server URL and the Asset last seen days filter.

Q: Expected vulnerabilities are missing.

A: The user may lack Host List Detection or KnowledgeBase access, the assets may be outside the user's scope, or the detections may not be in a supported status or type. Verify the Host List Detection and KnowledgeBase permissions and confirm the detections in Qualys.

Q: What happens if the tag filter is configured incorrectly?

A: If none of the configured tag names or IDs resolve, SAFE fails closed rather than syncing all assets.

Q: Qualys returned HTTP 409 or 429.

A: The tenant may have reached an API rate or concurrency limit. Retry later, reduce concurrent Qualys API activity, or review the tenant's API limits.

Q: The API Gateway URL is unreachable.

A: The URL may be incorrect, a network block may be in place, or the platform may not match. Confirm the customer's Qualys Gateway URL and allowlist the SAFE egress IPs if required.

Q: How should credentials be rotated?

A: Update the dedicated Qualys user's password in Qualys, update the password in the SAFE connector configuration, and run Test Connection before the next sync.