/api/2.0/fo/auth/jboss/
[POST]
Create, update, list and delete JBoss Server records for vulnerability and compliance scans (using VM, PC). Supports Windows and Unix platforms.
Supported technologies
Windows - WildFly/JBoss EAP
Unix - WildFly/JBoss EAP
Parameter |
Description |
action={action} |
(Required) Specify create, update, delete (using POST) or list (using GET or POST). See List Auth Records for type |
echo_request={0|1} |
(Optional) Specify 1 to view (echo) input parameters in the XML output. By default these are not included. |
ids={value} |
(Required) Specify a single or comma separated valid JBoss type auth record ID(s). |
title={value} |
(Required to create record) A title for the record. The title must be unique. |
comment={value} |
(Optional to create or update record) User defined comments. |
Windows platform |
|
windows_working_mode= |
(Optional) Input values should be standalone_mode or domain_controller_mode. |
windows_home_path={value} |
Required if windows working mode is selected. |
windows_base_path= |
Required if windows working mode is selected. |
windows_conf_dir_path= |
Required if windows working mode is selected. |
windows_conf_file_path= |
Required if windows working mode is selected. |
windows_conf_host_file_ |
Required if selected Windows working mode is domain controller. |
Unix platform |
|
unix_working_mode= |
(Optional) Input values should be standalone_mode or domain_controller_mode. |
unix_home_path={value} |
Required if Unix working mode is selected. |
unix_base_path={value} |
Required if Unix working mode is selected. |
unix_conf_dir_path= |
Required if Unix working mode is selected. |
unix_conf_file_path= |
Required if Unix working mode is selected. |
unix_conf_host_file_path= |
Required if selected Unix working mode is domain controller. |
Target Hosts |
|
ips={value} |
(Required to create record) The IP address(es) the server will log into using the record’s credentials. Multiple entries are comma separated. (Optional to update record) IPs specified will overwrite existing IPs in the record, and existing IPs will be removed. |
add_ips={value} |
(Optional and valid only to update record) IPs to be added to an existing record. You may enter a combination of IPs and IP ranges. Multiple entries are comma separated. |
remove_ips={value} |
(Optional and valid to update record) IPs to be removed from your record. You may enter a combination of IPs and ranges. Multiple entries are comma separated. |
network_id={value} |
(Optional to create or update record, and valid when the networks feature is enabled) The network ID for the record. |
API request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X POST
"action=create&title=jbos_rec&windows_working_mode=standalone_mode&windows_base_path=c:\&windows_home_path=c:\&windows_conf_file_path=c:\&windows_conf_dir_path=c:\&comment=record creation&ips=10.10.10.224" "https://qualysapi.qualys.com/api/2.0/fo/auth/jboss/" "https://qualysapi.qualys.com/api/2.0/fo/auth/jboss/""https://qualysapi.qualys.com/api/2.0/fo/auth/docker/"
XML output
<!DOCTYPE BATCH_RETURN SYSTEM "https://qualysapi.qualys.com/api/2.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2018-08-03T10:42:32Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Created</TEXT>
<ID_SET>
<ID>296004</ID>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
API request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -d "action=list&ids=296004" "https://qualysapi.qualys.com/api/2.0/fo/auth/jboss/"
XML output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_JBOSS_LIST_OUTPUT SYSTEM "https://qualysapi.qualys.com/api/2.0/fo/auth/jboss/auth_jboss_list_output.dtd">
<AUTH_JBOSS_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2018-08-03T10:44:39Z</DATETIME>
<AUTH_JBOSS_LIST>
<AUTH_JBOSS>
<ID>296004</ID>
<TITLE><![CDATA[jbos_rec]]></TITLE>
<IP_SET>
<IP>10.10.10.224</IP>
</IP_SET>
<WINDOWS>
<HOME_PATH><![CDATA[c:\]]></HOME_PATH>
<DOMAIN_MODE><![CDATA[true]]></DOMAIN_MODE>
<BASE_PATH><![CDATA[c:\]]></BASE_PATH>
<CONF_DIR_PATH><![CDATA[c:\]]></CONF_DIR_PATH>
<CONF_FILE_PATH><![CDATA[c:\]]></CONF_FILE_PATH>
<CONF_HOST_FILE_PATH><![CDATA[c:\]]></CONF_HOST_FILE_PATH>
</WINDOWS>
<NETWORK_ID>0</NETWORK_ID>
<CREATED>
<DATETIME>2018-08-03T10:42:32Z</DATETIME>
<BY>abc_pk</BY>
</CREATED>
<LAST_MODIFIED>
<DATETIME>2018-08-03T10:43:58Z</DATETIME>
</LAST_MODIFIED>
<COMMENTS><![CDATA[record creation]]></COMMENTS>
</AUTH_JBOSS>
</AUTH_JBOSS_LIST>
</RESPONSE>
</AUTH_JBOSS_LIST_OUTPUT>
Our online help includes sample JBoss records with various settings. To access online help log in to your Qualys account, go to Help > Online Help and search for JBoss.
<platform API server>/api/2.0/batch_return.dtd
<platform API server>/api/2.0/fo/auth/jboss/auth_jboss_list_output.dtd