Middleware Asset API

POST GET /api/2.0/fo/compliance/middleware/

We now support the Middleware Asset API that helps you list, activate, or deactivate middleware assets.

The list functionality supports filtering by IP address, such as, hostname, operating system, and middleware technology, providing capabilities similar to the Middleware Assets tab in the Policy Audit application.

Only users with the Manager role can activate, deactivate, and list middleware asset assessments.

Input Parameters to Active or Deactivate Middleware AssetsInput Parameters to Active or Deactivate Middleware Assets

Parameter Name	Required / Optional	Data Type	Description
action={value}	Required	String	Action to perform. Either activate or deactivate.
host_ids={value}	Required	Integer	Host IDs to activate or deactivate. Multiple entries can be added as comma seperate values. A maximum of 10000 host IDs can be added. Either host_ids or csv_data is required to activate or deactivate Middleware assets
csv_data	Required	String	CSV file containing host IDs to activate or deactivate (one per row or comma-separated). A maximum of 10000 host IDs can be added in the CSV file. Either host_ids or csv_data is required to activate or deactivate Middleware assets

Parameter Name

Required / Optional

Data Type

Description

action={value}

Required

String

Action to perform. Either activate or deactivate.

host_ids={value}

Required

Integer

Host IDs to activate or deactivate. Multiple entries can be added as comma seperate values.
A maximum of 10000 host IDs can be added.

Either host_ids or csv_data is required to activate or deactivate Middleware assets

csv_data

Required

String

CSV file containing host IDs to activate or deactivate (one per row or comma-separated).
A maximum of 10000 host IDs can be added in the CSV file.

Either host_ids or csv_data is required to activate or deactivate Middleware assets

Input Parameters to List all Middleware AssetsInput Parameters to List all Middleware Assets

Parameter Name	Required / Optional	Data Type	Description
action	Required	String	List action to be performed.
ips	Optional	Integer	Filter by IP addresses/ranges
hostname	Optional	String	Filter by hostname.
os	Optional	String	Filter by OS pattern (for example, hos.OS or amt.OS_NAME).
middleware_technology	Optional	String	Filter by middleware technology (for example, Apache, Tomcat).
status	Optional	String	Filter by activation status.
id_min	Optional	Integer	Minimum host ID for pagination.
id_max	Optional	Integer	Maximum host ID filter.
truncation_limit	Optional	Integer	Maximum records to be returned. Default value is set to 1000.

Sample - Activate Middleware AssetsSample - Activate Middleware Assets

API Request

curl -u "<username>:<password>" -H "X-Requested-With: curl" -k -v -d "action=activate&host_ids=7800999" <qualys_base_url>/api/2.0/fo/compliance/middleware/

API Response

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
    <RESPONSE>
        <DATETIME>2026-07-16T09:56:21Z</DATETIME>
        <TEXT>Middleware assessment activate request processed for 1 host(s)</TEXT>
        <ITEM_LIST>
            <ITEM>
                <KEY>Successfully activated</KEY>
                <VALUE>1</VALUE>
            </ITEM>
            <ITEM>
                <KEY>Failed to activate</KEY>
                <VALUE>0</VALUE>
            </ITEM>
        </ITEM_LIST>
    </RESPONSE>
</SIMPLE_RETURN>

Sample - Deactivate Middleware AssetsSample - Deactivate Middleware Assets

API Request

curl -u "<username>:<password>" -H "X-Requested-With: curl" -v -d "action=deactivate&host_ids=7800999" <qualys_base_url>/api/2.0/fo/compliance/middleware/

API Response

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
    <RESPONSE>
        <DATETIME>2026-07-16T09:55:24Z</DATETIME>
        <TEXT>Middleware assessment deactivate request processed for 1 host(s)</TEXT>
        <ITEM_LIST>
            <ITEM>
                <KEY>Successfully deactivated</KEY>
                <VALUE>1</VALUE>
            </ITEM>
            <ITEM>
                <KEY>Failed to deactivate</KEY>
                <VALUE>0</VALUE>
            </ITEM>
        </ITEM_LIST>
    </RESPONSE>
</SIMPLE_RETURN>

Sample - List all Middleware AssetsSample - List all Middleware Assets

API Request

curl -u "<username>:<password>" -H "X-Requested-With: curl" -v -d "action=list" <qualys_base_url>/api/2.0/fo/compliance/middleware/

API Response

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE MIDDLEWARE_ASSET_LIST_OUTPUT SYSTEM "<qualys_base_url>/api/2.0/fo/compliance/middleware/dtd/list/output.dtd">
<MIDDLEWARE_ASSET_LIST_OUTPUT>
    <RESPONSE>
        <DATETIME>2026-07-16T09:57:17Z</DATETIME>
        <MIDDLEWARE_ASSET_LIST>
            <MIDDLEWARE_ASSET>
                <ID>2064785</ID>
                <HOST_ID>7800999</HOST_ID>
                <IP>10.113.198.62</IP>
                <QG_HOSTID>9782c802-75f9-4c26-a15e-9020d6c9af55</QG_HOSTID>
                <HOSTNAME>drsqrchsql05.bbtnet.com</HOSTNAME>
                <OS>Windows Server 2019 Standard 64 bit Edition Version 1809 Build 17763</OS>
                <MIDDLEWARE_TECHNOLOGY>CHROME</MIDDLEWARE_TECHNOLOGY>
                <INSTANCE_COUNT>1</INSTANCE_COUNT>
                <STATUS>Successful Activation</STATUS>
                <UPDATED_DATE>2026-02-02 05:08:28</UPDATED_DATE>
            </MIDDLEWARE_ASSET>
            <MIDDLEWARE_ASSET>
                <ID>1937465</ID>
                <HOST_ID>7800999</HOST_ID>
                <IP>10.113.198.62</IP>
                <QG_HOSTID>9782c802-75f9-4c26-a15e-9020d6c9af55</QG_HOSTID>
                <HOSTNAME>drsqrchsql05.bbtnet.com</HOSTNAME>
                <OS>Windows Server 2019 Standard 64 bit Edition Version 1809 Build 17763</OS>
                <MIDDLEWARE_TECHNOLOGY>IEXPLORER</MIDDLEWARE_TECHNOLOGY>
                <INSTANCE_COUNT>1</INSTANCE_COUNT>
                <STATUS>Successful Activation</STATUS>
                <UPDATED_DATE>2026-02-02 05:08:28</UPDATED_DATE>
            </MIDDLEWARE_ASSET>
            <MIDDLEWARE_ASSET>
                <ID>1937466</ID>
                <HOST_ID>7800999</HOST_ID>
                <IP>10.113.198.62</IP>
                <QG_HOSTID>9782c802-75f9-4c26-a15e-9020d6c9af55</QG_HOSTID>
                <HOSTNAME>drsqrchsql05.bbtnet.com</HOSTNAME>
                <OS>Windows Server 2019 Standard 64 bit Edition Version 1809 Build 17763</OS>
                <MIDDLEWARE_TECHNOLOGY>SQLServer</MIDDLEWARE_TECHNOLOGY>
                <INSTANCE_COUNT>2</INSTANCE_COUNT>
                <STATUS>Successful Activation</STATUS>
                <UPDATED_DATE>2026-02-02 05:08:28</UPDATED_DATE>
            </MIDDLEWARE_ASSET>
        </MIDDLEWARE_ASSET_LIST>
    </RESPONSE>
</MIDDLEWARE_ASSET_LIST_OUTPUT>

Sample - Activate Middleware Assets using CSV fileSample - Activate Middleware Assets using CSV file

API Request

curl -u "<username>:<password>" \
  -H "X-Requested-With: curl" \
  -H "Content-Type: text/csv" \
  -v \
  --data-binary @/home/drive/host_id.csv \
  "<qualys_base_url>/api/2.0/fo/compliance/middleware/?action=activate"

API Response

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2026-07-17T10:32:10Z</DATETIME>
    <TEXT>Middleware assessment activate request processed for 1 host(s)</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>Successfully activated</KEY>
        <VALUE>1</VALUE>
      </ITEM>
      <ITEM>
        <KEY>Failed to activate</KEY>
        <VALUE>0</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

Sample - Deactivate Middleware Assets using CSV fileSample - Deactivate Middleware Assets using CSV file

API Request

curl -u "<username>:<password>" \
  -H "X-Requested-With: curl" \
  -H "Content-Type: text/csv" \
  -v \
  --data-binary @/home/drive/host_id.csv \
  "<qualys_base_url>/api/2.0/fo/compliance/middleware/?action=deactivate"

API Response

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2026-07-17T10:31:33Z</DATETIME>
    <TEXT>Middleware assessment deactivate request processed for 1 host(s)</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>Successfully deactivated</KEY>
        <VALUE>1</VALUE>
      </ITEM>
      <ITEM>
        <KEY>Failed to deactivate</KEY>
        <VALUE>0</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

Sample - Activate Middleware Assets with no instance dataSample - Activate Middleware Assets with no instance data

API Request

curl -u "<username>:<password>" -H "X-Requested-With: curl" -v -d "action=activate&host_ids=8262564,9774170,12329657" "<qualys_base_url>/api/2.0/fo/compliance/middleware/"

API Response

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2026-07-20T06:31:13Z</DATETIME>
    <TEXT>Middleware assessment activate request processed for 3 host(s)</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>Successfully activated</KEY>
        <VALUE>0</VALUE>
      </ITEM>
      <ITEM>
        <KEY>Failed to activate</KEY>
        <VALUE>0</VALUE>
      </ITEM>
      <ITEM>
        <KEY>Invalid host IDs (not PC/SCA agents, not in subscription, invalid tracking method, or no middleware instance data)</KEY>
        <VALUE>8262564, 9774170, 12329657</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

Sample - Deactivate Middleware Assets with no instance dataSample - Deactivate Middleware Assets with no instance data

API Request

curl -u "<username>:<password>" -H "X-Requested-With: curl" -v -d "action=deactivate&host_ids=8262564,9774170,12329657" "<qualys_base_url>/api/2.0/fo/compliance/middleware/"

API Response

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2026-07-20T06:33:23Z</DATETIME>
    <TEXT>Middleware assessment deactivate request processed for 3 host(s)</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>Successfully deactivated</KEY>
        <VALUE>0</VALUE>
      </ITEM>
      <ITEM>
        <KEY>Failed to deactivate</KEY>
        <VALUE>0</VALUE>
      </ITEM>
      <ITEM>
        <KEY>Invalid host IDs (not PC/SCA agents, not in subscription, invalid tracking method, or no middleware instance data)</KEY>
        <VALUE>8262564, 9774170, 12329657</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

Sample - Activate Host IDs that are not in subscription or with invalid Host IDSample - Activate Host IDs that are not in subscription or with invalid Host ID

API Request

curl -u "<username>:<password>" -H "X-Requested-With: curl" -k -v -d "action=activate&host_ids=3456782,5678932" "<qualys_base_url>/api/2.0/fo/compliance/middleware/"

API Response

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2026-07-20T10:41:59Z</DATETIME>
    <TEXT>Middleware assessment activate request processed for 2 host(s)</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>Successfully activated</KEY>
        <VALUE>0</VALUE>
      </ITEM>
      <ITEM>
        <KEY>Failed to activate</KEY>
        <VALUE>0</VALUE>
      </ITEM>
      <ITEM>
        <KEY>Invalid host IDs (not PC/SCA agents, not in subscription, invalid tracking method, or no middleware instance data)</KEY>
        <VALUE>3456782, 5678932</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

Sample - Deactivate Host IDs that are not in subscription or with invalid Host IDSample - Deactivate Host IDs that are not in subscription or with invalid Host ID

API Request

curl -u "<username>:<password>" -H "X-Requested-With: curl" -v -d "action=deactivate&host_ids=4563728,3782132" "<qualys_base_url>/api/2.0/fo/compliance/middleware/"

API Response

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM "<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2026-07-20T06:34:51Z</DATETIME>
    <TEXT>Middleware assessment deactivate request processed for 2 host(s)</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>Successfully deactivated</KEY>
        <VALUE>0</VALUE>
      </ITEM>
      <ITEM>
        <KEY>Failed to deactivate</KEY>
        <VALUE>0</VALUE>
      </ITEM>
      <ITEM>
        <KEY>Invalid host IDs (not PC/SCA agents, not in subscription, invalid tracking method, or no middleware instance data)</KEY>
        <VALUE>3782132, 4563728</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>