Create, update, list and delete Tomcat server records.
|
Parameter |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
|
tag_set_by={id|name} |
Optional when asset_type=asset_tags or ip_range_tag_rule | Integer/ String |
Specify "id" (the default) to select a tag set by providing tag ids. Specify "name" to select a tag set by providing tag names. |
|
tags_include={tag1, tag2...} |
Required when asset_type=asset_tags or ip_range_tag_rule | Integer |
Specify a tag set to include in the record. Hosts that match these tags will be included. You identify the tag set by providing tag names or IDs. Multiple entries are comma-separated. To specify tag names, you must also specify tag_set_by=name. |
|
tags_exclude={tag1, tag2...} |
Optional when asset_type=asset_tags or ip_range_tag_rule | Integer |
Specify a tag set to exclude in the record. Hosts that match these tags will be excluded. You identify the tag set by providing tag names or IDs. Multiple entries are comma-separated. To specify tag names, you must also specify tag_set_by=name. |
|
tag_include_selector={any|all} |
Optional when asset_type=asset_tags or ip_range_tag_rule | Boolean |
Select "any" (the default) to include hosts that match at least one of the selected tags. Select "all" to include hosts that match all of the selected tags. |
|
tag_exclude_selector={any|all} |
Optional when asset_type=asset_tags or ip_range_tag_rule | Boolean |
Select "any" (the default) to exclude hosts that match at least one of the selected tags. Select "all" to exclude hosts that match all of the selected tags. |
API Request
curl --location --request POST '<qualys_base_url>/api/3.0/fo/auth/tomcat/?action=create&instance_path=%2Fopt%2Fapach1e-tsomcat2-api&auto_discover_instances=1&echo_request=1&installation_path=%2Fopt%2Fpivotal%2Fpivotal-t2c-server-standsard1-api&title=API_TEST_2323_1779296368160&asset_type=asset_tags&tag_set_by=name&tags_include=Cloud%20Agent&tags_exclude=Cloud%20Agent' \ --header 'Content-Type: application/json' \ --header 'X-Requested-With: curl demo28' \ --header 'Cache-Control: no-cache' \ --header 'Accept: */*' \ --header 'Accept-Encoding: gzip, deflate, br' \ --header 'Content-Length: 0'
API Response
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "<qualys_base_url>/api/3.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2026-05-20T12:03:11Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Created</TEXT>
<ID_SET>
<ID>8904935</ID>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
API Request
curl -u "USER:PASSWORD" \
-H "X-Requested-With: curl" \
-X POST <qualys_base_url>/api/3.0/fo/auth/tomcat/?action=update\
&ids=<AUTH_RECORD_ID>\
&asset_type=ip_range_tag_rule\
&tag_set_by=id\
&tags_include=401,402\
&tags_exclude=403"
API Response
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "<qualys_base_url>/api/3.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2026-05-22T10:23:42Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Updated</TEXT>
<ID_SET>
<ID>8927402</ID>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
API Request
curl -u "USER:PASSWORD" \
-H "X-Requested-With: curl" \
-X POST "<qualys_base_url>/api/3.0/fo/auth/tomcat/?action=list"
API Response
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_TOMCAT_LIST_OUTPUT SYSTEM "<qualys_base_url>/api/3.0/fo/auth/tomcat/auth_tomcat_list_output.dtd">
<!-- This report was generated with an evaluation version of Qualys //-->
<AUTH_TOMCAT_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2026-05-22T13:20:54Z</DATETIME>
<AUTH_TOMCAT_LIST>
<AUTH_TOMCAT>
<ID>8929417</ID>
<TITLE>
<![CDATA[API_TEST_2323_1779296368160]]>
</TITLE>
<TAGS>
<TAG_TYPE>asset_tags</TAG_TYPE>
<TAGS_INCLUDE>
<SELECTOR>any</SELECTOR>
<TAG>
<ID>8214418</ID>
<NAME>Exc_1</NAME>
</TAG>
</TAGS_INCLUDE>
<TAGS_EXCLUDE>
<SELECTOR>any</SELECTOR>
<TAG>
<ID>7612812</ID>
<NAME>Cloud Agent</NAME>
</TAG>
</TAGS_EXCLUDE>
</TAGS>
<INSTALLATION_PATH>
<![CDATA[/opt/pivotal/pivotal-t2c-server-standsard1-api]]>
</INSTALLATION_PATH>
<INSTANCE_PATH>
<![CDATA[/opt/apach1e-tsomcat2-api]]>
</INSTANCE_PATH>
<AUTO_DISCOVER_INSTANCES>1</AUTO_DISCOVER_INSTANCES>
<NETWORK_ID>0</NETWORK_ID>
<CREATED>
<DATETIME>2026-05-22T13:20:37Z</DATETIME>
<BY>mayur_aa</BY>
</CREATED>
<LAST_MODIFIED>
<DATETIME>2026-05-22T13:20:37Z</DATETIME>
</LAST_MODIFIED>
<IS_SYSTEM_CREATED>0</IS_SYSTEM_CREATED>
<IS_ACTIVE>1</IS_ACTIVE>
</AUTH_TOMCAT>
</AUTH_TOMCAT_LIST>
</RESPONSE>
</AUTH_TOMCAT_LIST_OUTPUT>
<!-- This report was generated with an evaluation version of Qualys //-->
<!-- CONFIDENTIAL AND PROPRIETARY INFORMATION. Qualys provides it's Service "As Is," without any warranty of any kind. Qualys makes no warranty that the information contained in this report is complete or error-free. Copyright 2026, Qualys, Inc. //-->
<platform API server>/api/3.0/fo/auth/tomcat/