Qualys REST messages

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Qualys REST messages Configuration Compliance

    Qualys REST messages facilitate interactions with the Qualys API to obtain compliance data. This functionality is essential for ServiceNow customers looking to integrate compliance monitoring into their workflows effectively. The system includes several REST messages, each serving a specific purpose in retrieving different types of compliance-related information from Qualys.

    Show full answer Show less

    Key Features

    • Qualys PC Policies REST message: Retrieves policy data. Key parameters include:
      • action: Required parameter for operation type.
      • details: Modifiable to adjust the level of detail in the retrieved policies.
    • Qualys PC Controls REST message: Retrieves compliance controls information. Parameters mirror those of the PC Policies REST message.
    • Qualys PC Policies Detail REST message: Provides comprehensive policy details. Key parameters include:
      • showusercontrols: Optional to include user-defined controls.
      • showappendix: Optional to include appendix details in the output.
    • Qualys PC Results REST message: Retrieves compliance posture records. Notable parameters include:
      • showextendedevidence: Optional to display extended evidence information.
      • causeoffailure: Optional to return the cause of failure.
      • policyid: Required to show records for a specified compliance policy.
    • Qualys PCRS Policy Host Integration REST message: Retrieves host data for compliance evaluation using specified policy IDs.
    • Qualys PCRS Test Results Integration: Sends request parameters to fetch posture data, with options for evidence retrieval and data compression.

    Key Outcomes

    By utilizing these REST messages, ServiceNow customers can effectively manage and monitor compliance data from Qualys, enabling better visibility into their compliance posture. This integration allows for tailored data retrieval based on operational needs, enhancing decision-making and compliance reporting capabilities.

    Qualys REST messages are used to make calls to the Qualys API to fetch the compliance data.

    The following rest messages are shipped with the base system.

    Qualys PC Policies REST message

    The 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.

    Table 1. Qualys PC Policies REST message parameters
    Parameter Name Value Description
    action list Indicates the type of operation requested.

    Required parameter.
    details All

    Indicates the level of detail shown for policies retrieved.

    It is safe to modify as per your requirement.

    Qualys PC Controls REST message

    The Qualys PC Controls rest message retrieves compliance controls information for different control IDs from Qualys.

    Table 2. Qualys PC Controls REST message parameters
    Parameter Name Value Description
    action list Indicates the type of operation requested.

    Required parameter.
    details All

    Indicates the level of detail shown for controls retrieved.

    It is safe to modify as per your requirement.

    Qualys PC Policies Detail REST message

    The Qualys PC Policies Detail REST message retrieves the complete policy details, such as technologies and sections.

    Table 3. Qualys PC Policies Detail REST message parameters
    Parameter Value Description
    action list Indicates the type of operation being requested.

    Required parameter.
    show_user_controls Boolean
    • Set to 1 to include user-defined controls (UDCs) in the XML output.

    • When not specified, UDCs are not included.

    This is an optional parameter. It is safe to modify as per your requirement.
    show_appendix Boolean

    (Optional) Set to 1 to show the appendix section in the XML output. When unspecified.

    Qualys PC Results REST message

    The Qualys PC Results rest message retrieves compliance posture records from Qualys.

    Table 4. Qualys PC Results REST message parameters
    Source Field Value Description
    action list Indicates the type of operation requested.

    Required parameter. Changes are not recommended.
    show_extended_evidence Boolean
    • Set to 1 to show the extended evidence information in the output.
    • Set to 0 or when unspecified, the extended evidence information is not shown in the output.
    Note:
    • 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.
    • This parameter is not shipped with the base system.
    cause_of_failure Boolean

    If you pass '1', Qualys will return the cause of failure.

    If you pass '0', Qualys will not return these attributes.

    Note:
    This parameter is not shipped with the base system.
    policy_id Shows compliance posture information records for a specified policy. A valid policy ID is required.
    details All

    Indicates the level of detail shown for postures retrieved.

    It is safe to modify as per your requirement.
    show_remediation_info (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.

    Qualys PCRS Policy Host Integration REST message

    The Qualys PCRS Policy Host Integration retrieves host data from Qualys and processes it in your instance.

    Table 5. Qualys PCRS Policy Host Integration REST message parameters
    Parameter Name Value Description
    policyId ${lastRunDatetime}

    Policy IDs for compliance evaluation.

    Qualys PCRS Test Results Integration

    The table shows the request parameters that are sent.

    Table 6. Qualys PCRS Test Results Integration REST message parameters
    Parameter Name Value Description
    evidenceRequired ${lastRunDatetime}
    • The default value is 0, which indicates that evidence data will not be retrieved for the host posture.
    • Set the value to 1 to retrieve the evidence data.
      Note:
      Changing the value to 1 increases the time required to fetch posture data.
    compressionRequired
    • The default value is 1, which indicates that the output will be compressed.
    • Set the value to 0, if you don’t want the data to be compressed.
      Note:
      Not compressing the data increases the time required to fetch posture data.