Qualys API Framework
The Qualys TotalCloud API uses the following framework.
The URL for making API requests respects the following structure:
Request URL
https://<baseurl>/<module>/rest/<version>/<object>/<object_id>/<operation>
| Components | Description |
|---|---|
|
<baseurl> |
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: |
|
<module> |
The API module. For TotalCloud, the module is: |
| <version> | The API version. Example: v1 |
|
<object> |
For TotalCloud, the <object> here can be either the cloud-provider name, ex, aws, or it can be the module-specific objects such as remediation, reports etc |
|
<object_id> |
(Optional) The module-specific object ID, if applicable. |
|
<operation> |
The request operation, such as GET, POST |