Prerequisites
-
An account with Administration privileges in Qualys
-
The API host URL for the platform (region) you’ll be working with
Role Management (Prepare the role first)
Purpose: Assign a role that follows the principle of least privilege for the data you’ll pull via API.
-
Go to Administration → Role Management in Qualys.
-
Do one of the following:
-
Recommended: Use the existing Unit Manager role (API Access must be enabled), or
-
Least privilege: Create a New Role and grant only the required permissions.
-
-
On the role, enable “API Access” (✔ Enabled).
-
Permissions (grant at least Read depending on the endpoints you’ll call):
-
Scanner Appliances → the necessary Read/List permissions (for appliance inventory/health)
-
-
(Optional) Narrow the Business Unit scope; allow access only to the needed asset groups/tags.
Note: The Reader role typically returns 401/unauthorized for API calls. Use Unit Manager or a custom role with API Access enabled instead.
Create a User with API Access (on Qualys VMDR)
To integrate Qualys VMDR with Logsign USO, first, create a user with API access in Qualys:
- Log in to your Qualys instance with Admin privileges.
- Select Administration from the dropdown menu at the top-left.
- On the Administration page, click the Create User button.
- Select Create Unit Manager User.
- Configure the new user with the following settings:
- User Role: Unit Manager or higher.
- API Access: ✔ Enabled
- GUI Access: ✔ Enabled
- Click Save.
- The new user will receive an email to verify their login and complete the registration process. Ensure that the user activates their account.
Determine Your Qualys API Host URL
Your API endpoint URL depends on the region where your Qualys instance is hosted. Identify your platform’s URL from the Qualys API Documentation.
Common Examples:
| https://qualysguard.qualys.com |
| https://qualysguard.qg2.apps.qualys.com |
| https://qualysguard.qg3.apps.qualys.com |
| https://qualysguard.qg4.apps.qualys.com |
| https://qualysguard.qualys.eu |
| https://qualysguard.qg2.apps.qualys.eu |
| https://qualysguard.qg3.apps.qualys.it |
| https://qualysguard.qg1.apps.qualys.in |
| https://qualysguard.qg1.apps.qualys.ca |
| https://qualysguard.qg1.apps.qualys.ae |
| https://qualysguard.qg1.apps.qualys.co.uk |
| https://qualysguard.qg1.apps.qualys.com.au |
| https://qualysguard.qg1.apps.qualysksa.com |
Make sure you select the correct URL for your environment.
Data to Pull from Qualys VMDR to Logsign USO
With Logsign USO, you can retrieve the following Qualys data:
- /api/2.0/fo/appliance