> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/qualys.md).

# Qualys

Search Qualys assets and vulnerability data, launch and monitor VM scans, and react to host detection status changes.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Qualys    | Credentials    |

### Qualys

Connect to a regional Qualys API Server with an API-enabled username and password to search assets, inspect vulnerabilities, launch VM scans, and monitor detections.

#### Set up in Qualys

1. Prepare the Qualys account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Server URL:** Your account's regional Qualys API Server URL, as a bare HTTPS origin with no path. Find it in the Qualys platform identification table. Use the API Server URL for Basic authentication, not an API Gateway URL.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Qualys**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field  | Required | What to enter                                                                                                                                                                                                                                                                                                |
| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| API Server URL | Yes      | Your account's regional Qualys API Server URL, as a bare HTTPS origin with no path. Find it in the Qualys platform identification table. Use the API Server URL for Basic authentication, not an API Gateway URL. [Provider instructions](https://www.qualys.com/platform-identification).                   |
| Username       | Yes      | An active Qualys user with API access and access to the required assets. Scanner or Reader can perform VM reads; scan launch requires Scanner, Unit Manager, or Manager access. [Provider instructions](https://docs.qualys.com/en/vm/qweb-all-api/mergedProjects/qapi-auth/get_started/authentication.htm). |
| Password       | Yes      | The password for the Qualys API user. [Provider instructions](https://docs.qualys.com/en/vm/qweb-all-api/mergedProjects/qapi-auth/get_started/authentication.htm).                                                                                                                                           |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Qualys** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Search Assets

Find Qualys assets by a familiar inventory field and return a bounded page of matches.

#### Inputs

| Field                | Type            | Required | Description                                                                                                                                    |
| -------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| Search field         | select (string) | Yes      | Asset property to search. Available values: Asset name, IP address, DNS host name, Operating system, Tracking method, Tag name. Default: name. |
| Match type           | select (string) | Yes      | How the asset field should match the search value. Available values: Contains, Equals, Does not equal. Default: EQUALS.                        |
| Search value         | string          | Yes      | Value to match in the selected asset field.                                                                                                    |
| Maximum assets       | integer         | No       | Maximum asset records to return. Minimum: 1. Maximum: 1000. Default: 100.                                                                      |
| Start after asset ID | integer         | No       | Continuation asset ID from an earlier search. Minimum: 1.                                                                                      |

#### Outputs

| Field         | Type          | Description                                        |
| ------------- | ------------- | -------------------------------------------------- |
| Assets        | object\_array | Structured Qualys host assets matching the search. |
| Asset count   | integer       | Number of assets returned.                         |
| Next asset ID | integer       | Asset ID used to continue a truncated search.      |

### List Asset Hosts

List scanned Qualys hosts with optional inventory, scan-date, tag, and TruRisk filters.

#### Inputs

| Field                 | Type            | Required | Description                                                                                                                                                 |
| --------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Host IDs              | string          | No       | Optional comma-separated Qualys host IDs or ID ranges.                                                                                                      |
| IP addresses          | string          | No       | Optional comma-separated IPv4 addresses or ranges.                                                                                                          |
| Minimum TruRisk score | integer         | No       | Only include hosts at or above this TruRisk score. Minimum: 0. Maximum: 1000.                                                                               |
| Maximum hosts         | integer         | No       | Maximum host records to return. Minimum: 1. Maximum: 1000. Default: 100.                                                                                    |
| Advanced options      | boolean         | No       | Show less common host filters and pagination settings. Default: false.                                                                                      |
| Asset groups          | string          | No       | Optional comma-separated Qualys asset group titles.                                                                                                         |
| Asset tags            | string          | No       | Optional comma-separated tag names; any selected tag may match.                                                                                             |
| Last VM scan after    | datetime        | No       | Only include hosts whose vulnerability scan ended after this time.                                                                                          |
| Detail level          | select (string) | No       | Amount of inventory and asset-group detail returned per host. Available values: Basic, Basic with asset groups, All, All with asset groups. Default: Basic. |
| Start after host ID   | integer         | No       | Continuation host ID from an earlier listing.                                                                                                               |

#### Outputs

| Field        | Type          | Description                                             |
| ------------ | ------------- | ------------------------------------------------------- |
| Hosts        | object\_array | Structured scanned hosts visible to the connected user. |
| Host count   | integer       | Number of hosts returned.                               |
| Next host ID | integer       | Host ID used to continue a truncated listing.           |

### Get Knowledge Base

Retrieve Qualys vulnerability metadata for a bounded set of QIDs.

#### Inputs

| Field          | Type            | Required | Description                                                                                                                   |
| -------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
| QIDs           | string          | Yes      | Comma-separated Qualys vulnerability IDs or ranges to retrieve.                                                               |
| Detail level   | select (string) | No       | Amount of vulnerability detail to return. Available values: Basic, All, None. Default: All.                                   |
| Patchability   | select (string) | No       | Optionally keep only patchable or unpatchable vulnerabilities. Available values: Any, Patchable, Not patchable. Default: Any. |
| Modified after | datetime        | No       | Only return QIDs modified after this time.                                                                                    |

#### Outputs

| Field               | Type          | Description                                              |
| ------------------- | ------------- | -------------------------------------------------------- |
| Vulnerabilities     | object\_array | Structured KnowledgeBase records for the requested QIDs. |
| Vulnerability count | integer       | Number of KnowledgeBase records returned.                |

### List Host Detections

List current vulnerability detections with host, QID, severity, status, score, and update-time filters.

#### Inputs

| Field                      | Type     | Required | Description                                                                                           |
| -------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------- |
| Host IDs                   | string   | No       | Optional comma-separated Qualys host IDs or ranges.                                                   |
| IP addresses               | string   | No       | Optional comma-separated IPv4 addresses or ranges.                                                    |
| QIDs                       | string   | No       | Optional comma-separated Qualys vulnerability IDs or ranges.                                          |
| Severities                 | string   | No       | Comma-separated Qualys severity levels to include. Default: 1,2,3,4,5.                                |
| Detection statuses         | string   | No       | Comma-separated detection statuses to include. Default: New,Active,Re-Opened,Fixed.                   |
| Minimum detection score    | integer  | No       | Only include detections at or above this Qualys Detection Score. Minimum: 1. Maximum: 100.            |
| Maximum hosts              | integer  | No       | Maximum host records whose detections should be returned. Minimum: 1. Maximum: 1000. Default: 100.    |
| Maximum detections         | integer  | No       | Soft cap on vulnerability detections returned across hosts. Minimum: 1. Maximum: 1000. Default: 1000. |
| Advanced options           | boolean  | No       | Show time filters, evidence, and continuation settings. Default: false.                               |
| Status changed after       | datetime | No       | Only include detections whose status changed after this time.                                         |
| Status changed before      | datetime | No       | Only include detections whose status changed before this time.                                        |
| Include detection evidence | boolean  | No       | Include provider evidence text for each detection. Default: false.                                    |
| Start after host ID        | integer  | No       | Continuation host ID from an earlier detection listing.                                               |

#### Outputs

| Field           | Type          | Description                                             |
| --------------- | ------------- | ------------------------------------------------------- |
| Detections      | object\_array | Structured host vulnerability detections.               |
| Host count      | integer       | Number of host records processed.                       |
| Detection count | integer       | Number of vulnerability detections returned.            |
| Next host ID    | integer       | Host ID used to continue a truncated detection listing. |

### Launch VM scan

Launch a Qualys vulnerability scan for one clear target selection.

#### Inputs

| Field                | Type            | Required | Description                                                                                                                            |
| -------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| Scan title           | string          | Yes      | Name shown for the new scan in Qualys.                                                                                                 |
| Target type          | select (string) | Yes      | How the scan targets are identified. Available values: IP addresses, Asset group names, Asset tag names, FQDNs. Default: IP addresses. |
| Targets              | string          | Yes      | Comma-separated targets for this scan.                                                                                                 |
| Option profile       | select (string) | Yes      | Existing VM option profile that controls scan behavior. Options load from the selected connection.                                     |
| Scanner              | select (string) | No       | Scanner appliance to use; External uses Qualys-hosted scanners. Options load from the selected connection. Default: External.          |
| Exclude IP addresses | string          | No       | IPv4 addresses or ranges to exclude from this scan.                                                                                    |
| Tag match            | select (string) | No       | For tag targets, require any selected tag or all selected tags. Available values: Any tag, All tags. Default: any.                     |
| Processing priority  | select (string) | No       | Qualys processing priority for the VM scan. Available values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9. Default: 0.                                |

#### Outputs

| Field          | Type    | Description                                      |
| -------------- | ------- | ------------------------------------------------ |
| Scan ID        | integer | Qualys identifier for the launched scan.         |
| Scan reference | string  | Reference used to look up the asynchronous scan. |
| Launch message | string  | Qualys confirmation for the launch.              |

### Get VM scan status

Look up the current state and details of one launched Qualys VM scan.

#### Inputs

| Field          | Type   | Required | Description                                       |
| -------------- | ------ | -------- | ------------------------------------------------- |
| Scan reference | string | Yes      | Reference returned when the VM scan was launched. |

#### Outputs

| Field | Type    | Description                                        |
| ----- | ------- | -------------------------------------------------- |
| Found | boolean | Whether the scan is visible to the connected user. |
| Scan  | object  | Structured scan status and metadata.               |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### Host Detection Status Changed

Starts a workflow when a visible Qualys host vulnerability detection changes to New, Active, Re-Opened, or Fixed.

Choose the lowest severity and optional Qualys Detection Score to watch. The trigger checks at most once per hour.

#### Configuration

| Field                      | Type            | Required | Description                                                                                                                                           |
| -------------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| Minimum severity           | select (string) | No       | Lowest Qualys severity that should start the workflow. Available values: 1 and above, 2 and above, 3 and above, 4 and above, 5 and above. Default: 1. |
| Minimum detection score    | integer         | No       | Only trigger at or above this Qualys Detection Score. Minimum: 1. Maximum: 100.                                                                       |
| Include detection evidence | boolean         | No       | Include provider evidence text in each trigger event. Default: false.                                                                                 |

#### Event inputs

| Field                   | Type     | Required | Description                                                 |
| ----------------------- | -------- | -------- | ----------------------------------------------------------- |
| Event ID                | string   | Yes      | Stable derived identifier for this detection status change. |
| Host ID                 | integer  | Yes      | Qualys host where the detection changed.                    |
| Asset ID                | integer  | No       | Qualys Asset Management ID when returned.                   |
| Host IP                 | string   | Yes      | IP address of the affected host.                            |
| QID                     | integer  | Yes      | Qualys vulnerability ID whose status changed.               |
| Unique vulnerability ID | string   | No       | Qualys detection-instance identifier when available.        |
| Status                  | string   | Yes      | New detection status.                                       |
| Severity                | integer  | Yes      | Qualys severity from 1 through 5.                           |
| Detection score         | integer  | No       | Qualys Detection Score when available.                      |
| Changed at              | datetime | Yes      | Time Qualys recorded the status change.                     |
| Detection               | object   | Yes      | Complete structured detection event.                        |

#### Outputs

| Field                   | Type     | Description                                                 |
| ----------------------- | -------- | ----------------------------------------------------------- |
| Event ID                | string   | Stable derived identifier for this detection status change. |
| Host ID                 | integer  | Qualys host where the detection changed.                    |
| Asset ID                | integer  | Qualys Asset Management ID when returned.                   |
| Host IP                 | string   | IP address of the affected host.                            |
| QID                     | integer  | Qualys vulnerability ID whose status changed.               |
| Unique vulnerability ID | string   | Qualys detection-instance identifier when available.        |
| Status                  | string   | New detection status.                                       |
| Severity                | integer  | Qualys severity from 1 through 5.                           |
| Detection score         | integer  | Qualys Detection Score when available.                      |
| Changed at              | datetime | Time Qualys recorded the status change.                     |
| Detection               | object   | Complete structured detection event.                        |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/qualys.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
