{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":43739,"path":"security-management/configuration-compliance/qualys-rest-messages-cc.md","title":"Qualys REST messages","bundle":null,"doc_type":null,"release":"australia","body":"\n# Qualys REST messages\n\nQualys REST messages are used to make calls to the Qualys API to fetch the compliance data.\n\nThe following rest messages are shipped with the base system.\n\n## Qualys PC Policies REST message\n\nThe Qualys PC Policies REST message retrieves policy data from Qualys. The changes to the REST message method record impact the request made to Qualys to retrieve policy information.\n\nStarting with v12.21.0 of Qualys Integration for Security Operations and v30.3.0 of Unified Security Exposure Management, the API version has been updated to version 5.0.\n\n<table id=\"table_v2g_x1q_dt\"><thead><tr><th>\n\nParameter Name\n\n</th><th>\n\nValue\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\naction\n\n</td><td>\n\nlist\n\n</td><td>\n\nIndicates the type of operation requested. Required parameter.\n\n</td></tr><tr><td>\n\ndetails\n\n</td><td>\n\nAll\n\n</td><td>\n\nIndicates the level of detail shown for policies retrieved.\n\n It is safe to modify as per your requirement.\n\n</td></tr></tbody>\n</table>## Qualys PC Controls REST message\n\nThe Qualys PC Controls rest message retrieves compliance controls information for different control IDs from Qualys.\n\n<table id=\"table_n3s_b1p_mxb\"><thead><tr><th>\n\nParameter Name\n\n</th><th>\n\nValue\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\naction\n\n</td><td>\n\nlist\n\n</td><td>\n\nIndicates the type of operation requested. Required parameter.\n\n</td></tr><tr><td>\n\ndetails\n\n</td><td>\n\nAll\n\n</td><td>\n\nIndicates the level of detail shown for controls retrieved.\n\n It is safe to modify as per your requirement.\n\n</td></tr></tbody>\n</table>## Qualys PC Policies Detail REST message\n\nThe Qualys PC Policies Detail REST message retrieves the complete policy details, such as technologies and sections.\n\nStarting with v12.21.0 of Qualys Integration for Security Operations and v30.3.0 of Unified Security Exposure Management, the API version has been updated to version 5.0.\n\n<table id=\"table_v2g_x1q_du\"><thead><tr><th>\n\nParameter\n\n</th><th>\n\nValue\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\naction\n\n</td><td>\n\nlist\n\n</td><td>\n\nIndicates the type of operation being requested. Required parameter.\n\n</td></tr><tr><td>\n\nshow\\_user\\_controls\n\n</td><td>\n\nBoolean\n\n</td><td>\n\n-   Set to 1 to include user-defined controls \\(UDCs\\) in the XML output.\n-   When not specified, UDCs are not included.\n\n\n This is an optional parameter. It is safe to modify as per your requirement.\n\n</td></tr><tr><td>\n\nshow\\_appendix\n\n</td><td>\n\nBoolean\n\n</td><td>\n\n\\(Optional\\) Set to 1 to show the appendix section in the XML output. When unspecified.\n\n</td></tr></tbody>\n</table>## Qualys PC Results REST message\n\nThe Qualys PC Results rest message retrieves compliance posture records from Qualys.\n\n<table id=\"table_v2g_x1q_dv\"><thead><tr><th>\n\nSource Field\n\n</th><th>\n\nValue\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\naction\n\n</td><td>\n\nlist\n\n</td><td>\n\nIndicates the type of operation requested. Required parameter. Changes are not recommended.\n\n</td></tr><tr><td>\n\nshow\\_extended\\_evidence\n\n</td><td>\n\nBoolean\n\n</td><td>\n\n-   Set to 1 to show the extended evidence information in the output.\n-   Set to 0 or when unspecified, the extended evidence information is not shown in the output.\n\n **Note:**\n\n-   You cannot specify `show_extended_evidence=1` in the same request as `hide_evidence=1`. This results in an error. The extended evidence is a part of the evidence data and it’s shown only when evidence data is shown.\n-   This parameter is not shipped with the base system.\n\n</td></tr><tr><td>\n\ncause\\_of\\_failure\n\n</td><td>\n\nBoolean\n\n</td><td>\n\nIf you pass '1', Qualys will return the cause of failure.\n\n If you pass '0', Qualys will not return these attributes.\n\n **Note:** This parameter is not shipped with the base system.\n\n</td></tr><tr><td>\n\npolicy\\_id\n\n</td><td>\n\n \n\n</td><td>\n\nShows compliance posture information records for a specified policy. A valid policy ID is required.\n\n</td></tr><tr><td>\n\ndetails\n\n</td><td>\n\nAll\n\n</td><td>\n\nIndicates the level of detail shown for postures retrieved.\n\n It is safe to modify as per your requirement.\n\n</td></tr><tr><td>\n\nshow\\_remediation\\_info\n\n</td><td>\n\n \n\n</td><td>\n\n\\(Optional\\) Set to 1 to show remediation information in the XML or CSV output. By default, the output does not include the remediation information. When not specified, the remediation information is not included in the output.\n\n</td></tr></tbody>\n</table>## Qualys PCRS Policy Host Integration REST message\n\nThe Qualys PCRS Policy Host Integration retrieves host data from Qualys and processes it in your instance.\n\nStarting with v12.21.0 of Qualys Integration for Security Operations and v30.3.0 of Unified Security Exposure Management, the API version has been updated to version 5.0.\n\n<table id=\"table_v2g_x1q_dw\"><thead><tr><th>\n\nParameter Name\n\n</th><th>\n\nValue\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\npolicyId\n\n</td><td>\n\n$\\{lastRunDatetime\\}\n\n</td><td>\n\nPolicy IDs for compliance evaluation.\n\n</td></tr></tbody>\n</table>## Qualys PCRS Test Results Integration\n\nThe table shows the request parameters that are sent.\n\nStarting with v12.21.0 of Qualys Integration for Security Operations and v30.3.0 of Unified Security Exposure Management, the API version has been updated to version 5.0.\n\n<table id=\"table_bpb_pgp_mxb\"><thead><tr><th>\n\nParameter Name\n\n</th><th>\n\nValue\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nevidenceRequired\n\n</td><td>\n\n1\n\n</td><td>\n\n-   The default value is 1, which indicates that evidence data will be retrieved for the host posture.\n-   Set the value to 0 to retrieve the evidence data.\n\n**Note:** Changing the value to 1 increases the time required to fetch posture data.\n\n\n</td></tr><tr><td>\n\ncompressionRequired\n\n</td><td>\n\n0\n\n</td><td>\n\n-   The default value is 0, which indicates that the output will not be compressed.\n-   Set the value to 1, if you want the data to be compressed.\n\n**Note:** Not compressing the data increases the time required to fetch posture data.\n\n\n</td></tr></tbody>\n</table>## Qualys Comprehensive PCRS Policy Host Integration REST message\n\nThe Qualys Comprehensive PCRS Policy Host Integration retrieves host data from Qualys and processes it in your instance.\n\nStarting with v12.21.0 of Qualys Integration for Security Operations and v30.3.0 of Unified Security Exposure Management, the API version has been updated to version 5.0.\n\n| | | |\n|---|---|---|\n|policyId|$\\{policyId\\}|Policy IDs for compliance evaluation.|\n\n## Qualys Comprehensive PCRS Test Results Integration\n\nThe table shows the request parameters that are sent.\n\nStarting with v12.21.0 of Qualys Integration for Security Operations and v30.3.0 of Unified Security Exposure Management, the API version has been updated to version 5.0.\n\n<table id=\"table_kmd_ppw_l3c\"><thead><tr><th>\n\nParameter Name\n\n</th><th>\n\nValue\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nevidenceRequired\n\n</td><td>\n\n1\n\n</td><td>\n\n-   The default value is 1, which indicates that evidence data will be retrieved for the host posture.\n-   Set the value to 0 to retrieve the evidence data.\n\n**Note:** Changing the value to 1 increases the time required to fetch posture data.\n\n\n</td></tr><tr><td>\n\ncompressionRequired\n\n</td><td>\n\n0\n\n</td><td>\n\n-   The default value is 0, which indicates that the output will not be compressed.\n-   Set the value to 1, if you want the data to be compressed.\n\n**Note:** Not compressing the data increases the time required to fetch posture data.\n\n\n</td></tr></tbody>\n</table>"}}