The Qualys Out-of-band Configuration Assessment API uses the following framework.
|
Components |
Mandatory/ Optional |
Data Type |
Description |
|---|---|---|---|
|
<baseurl> |
Mandatory | URL |
The Qualys API gateway URL that you should use for API requests depends on the platform where your account is located. The gateway URL for Qualys US Platform 1 is: https://gateway.qg1.apps.qualys.com |
|
<module> |
Mandatory | Text |
The API module. For the OCA API, the module is: 'oca'. |
|
<object> |
Mandatory | Text |
The module-specific object. |
|
<object_id> |
Optional | Integer |
The module specific object ID, if appropriate. |
|
<operation> |
Mandatory | Text |
The request operation, such as provisioning an asset. |
The URL for making API requests respects the following structure
https://<qualys_base_url>/<module>/<object>/<object_id>/<operation>