Qualys API Framework

The Qualys VMDR Mobile API uses the following framework.

Request URL

The URL for making API requests respects the following structure:
<qualys_base_url>/<module>/<object>/<object_id>/<operation> where the components are described as follows:

Fields

Description

<qualys_base_url>

The Qualys API server URL that you should use for API requests depends on the platform where your account is located.

The base URL for Qualys US Platform 1 is:
https://gateway.qg1.apps.qualys.com

<module> The API module.
<object> The module-specific object.
<object_id> (Optional) The module-specific object ID, if appropriate.
<operation>

The request operation, such as count.

Qualys API Gateway URL

The Qualys API URL you should use for API requests depends on the Qualys platform where your account is located.

Click here to identify your Qualys platform and get the API URL

This documentation uses <qualys_base_url>  in the sample API requests. If you’re on another platform, please replace this URL with the appropriate gateway URL for your account.

Example: https://gateway.qg1.apps.qualys.com