Create, update, list and delete Oracle HTTP Server records for authenticating to Unix and Windows systems. Vulnerability and Compliance scans are supported (using VM, PC). User permissions for this API are the same as other authentication record APIs. Note that the API supports authentication record creation only for Oracle Server installed on respective OS - Unix or Windows.
Parameter |
Required/Optional |
Data Type |
Description |
---|---|---|---|
title={value} | Required to create record | String | A title for the record. The title must be unique. Maximum 255 characters (ascii). |
network_id={value} | Optional and valid when the networks feature is enabled | Integer | The network ID for the record. |
add_ips={value} | Optional to update record | Integer | Add IPs to the IPs list for this record. Multiple IPs/ranges are comma separated. |
comments={value} | Optional to create or update record | String | User defined comments. Maximum of 1999 characters. |
action={action} | Required | String | Specify create, update, delete (using POST) or list (using GET or POST). |
ips={value} | Required to create record | Integer | 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. |
ids={value} | Required to update or delete record | Integer | Record Oracle HTTP type auth record IDs to update. Specify record IDs and/or ID ranges (for example, 1359-1407). Multiple entries are comma separated. |
Unix Configuration |
|
||
unix_home_path={value} | Required to create or update record if Unix working mode is selected | Path | Absolute path to the top level directory where domains are configured. Maximum of 255 characters. |
unix_domain_path={value} | Required to create or update record if Unix working mode is selected for Oracle HTTP Server 12c and higher | Path | Absolute path to the top level directory where domains are configured. Maximum of 255 characters. |
unix_inst_path={value} | Required to create or update record if Unix working mode is selected for Oracle HTTP Server 11g | Path | Absolute path to the top level directory where instances are configured. Maximum of 255 characters. |
unix_inst_name={value} | Optional | String | The Oracle HTTP server instance name. Maximum of 4000 characters. |
Windows Configuration |
|
||
windows_home_path={value} | Required to create or update record if Windows working mode is selected | Path | The home directory path. Maximum of 255 characters. |
windows_domain_path={value} | Required to create or update record if Windows working mode is selected for Oracle HTTP Server 12c and higher | Path | Absolute path to the top level directory where domains are configured. Maximum of 255 characters. |
windows_inst_path={value} | Required to create or update record if Windows working mode is selected for Oracle HTTP Server 11g | Path | Absolute path to the top level directory where domains are configured. Maximum of 255 characters. |
windows_inst_name={value} | Optional | String | The Oracle HTTP server instance name. Maximum of 4000 characters. |
API Request
curl -u "USERNAME:PASSWORD" -S -H 'X-Requested-With:curl demo2' -d "action=create&title=Oracle_HTTP_Unix server_11&unix_home_path=/opt/Oracle/Middleware/Oracle_WT1&unix_in st_path=/opt/Oracle/Middleware/Oracle_WT1/instances/instance1&unix _inst_name=ohs1&ips=10.11.70.24" "https://<qualys_base_url>/api/2.0/fo/auth/oracle_http_server/"
XML Output
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE BATCH_RETURN SYSTEM "https://<qualys_base_url>/api/2.0/batch_return.dtd"> <BATCH_RETURN> <RESPONSE> <DATETIME>2019-10-15T05:51:21Z</DATETIME> <BATCH_LIST> <BATCH> <TEXT>Successfully Created</TEXT> <ID_SET> <ID>1530246</ID> </ID_SET> </BATCH> </BATCH_LIST> </RESPONSE> </BATCH_RETURN>
API Request
curl -u "USERNAME:PASSWORD" -S -H 'X-Requested-With:curl demo2' -d "action=create&title=Oracle_HTTP_Windows_server_11&windows_home_pa th=C:\Middleware\Oracle_WT1&windows_inst_path=C:\Middleware\Oracle _WT1\instances\instance1&windows_inst_name=ohs1&ips=10.11.70.193" "https://<qualys_base_url>/api/2.0/fo/auth/oracle_http_server/"
XML Output
<<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM
"https://<qualys_base_url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2019-10-15T05:50:01Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Created</TEXT>
<ID_SET>
<ID>1530243</ID>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
API Request
curl -u "USERNAME:PASSWORD" -S -H 'X-Requested-With:curl demo2' -d "action=create&title=Oracle_HTTP_Unix server_12&unix_home_path=/opt/Oracle/Middleware/Oracle_Home&unix_d omain_path=/opt/Oracle/Middleware/Oracle_Home/user_projects/domain s/base_domain&windows_inst_name=ohs1&ips=10.11.70.68" "https://<qualys_base_url>/api/2.0/fo/auth/oracle_http_server/"
XML Output
<<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM
"https://<qualys_base_url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2019-10-15T05:45:50Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Created</TEXT>
<ID_SET>
<ID>1530234</ID>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
API Request
curl -u "USERNAME:PASSWORD" -S -H 'X-Requested-With:curl demo2' -d "action=create&title=Oracle_HTTP_Windows server_12&windows_home_path=C:\Oracle\Middleware\Oracle_Home&windo ws_domain_path=C:\Oracle\Middleware\Oracle_Home\user_projects\doma ins\base_domain&windows_inst_path=C:\Oracle\Middleware\Oracle_Home \instances\instance1&windows_inst_name=ohs1&ips=10.11.70.84" "https://<qualys_base_url>/api/2.0/fo/auth/oracle_http_server/"
XML Output
<<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM
"https://<qualys_base_url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2019-10-15T05:48:55Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Created</TEXT>
<ID_SET>
<ID>1530241</ID>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
API Request
curl -u "USERNAME:PASSWORD" -S -H 'X-Requested-With:curl demo2' -d "action=update&ids=1530246&unix_home_path=/opt/Oracle/Middleware/O racle_WT1&unix_inst_path=/opt/Oracle/Middleware/Oracle_WT1/instanc es/instance1&unix_inst_name=ohs1&ips=10.11.70.24&comments=ohs unix auth record updated" "https://<qualys_base_url>/api/2.0/fo/auth/oracle_http_server/"
XML Output
<<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM
"https://<qualys_base_url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2019-10-15T06:01:38Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Updated</TEXT>
<ID_SET>
<ID>1530246</ID>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
API Request
curl -u "USERNAME:PASSWORD" -S -H 'X-Requested-With:curl demo2' -d "action=update&ids=1530243&windows_home_path=C:\Middleware\Oracle_ WT1&windows_inst_path=C:\Middleware\Oracle_WT1\instances\instance1 &windows_inst_name=ohs1&ips=10.11.70.193&comments=ohs wind auth record updated" "https://<qualys_base_url>/api/2.0/fo/auth/oracle_http_server/"
XML Output
<<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM
"https://<qualys_base_url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2019-10-15T06:05:43Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Updated</TEXT>
<ID_SET>
<ID>1530243</ID>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
API Request
curl -u "USERNAME:PASSWORD" -S -H 'X-Requested-With:curl demo2' -d "action=update&ids=1530234&unix_home_path=/opt/Oracle/Middleware/O racle_Home&unix_domain_path=/opt/Oracle/Middleware/Oracle_Home/use r_projects/domains/base_domain&windows_inst_name=ohs1&ips=10.11.70 .68&comments=ohs unix auth record updated" "https://<qualys_base_url>/api/2.0/fo/auth/oracle_http_server/"
XML Output
<<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM
"https://<qualys_base_url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2019-10-15T06:14:31Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Updated</TEXT>
<ID_SET>
<ID>1530234</ID>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
API Request
curl -u "USERNAME:PASSWORD" -S -H 'X-Requested-With:curl demo2' -d "action=update&ids=1530241&windows_home_path=C:\Oracle\Middleware\ Oracle_Home&windows_domain_path=C:\Oracle\Middleware\Oracle_Home\u ser_projects\domains\base_domain&windows_inst_path=C:\Oracle\Middl eware\Oracle_Home\instances\instance1&windows_inst_name=ohs1&ips=1 0.11.70.84&comments=ohs wind auth record updated" "https://<qualys_base_url>/api/2.0/fo/auth/oracle_http_server/"
XML Output
<<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM
"https://<qualys_base_url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2019-10-15T06:11:46Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Updated</TEXT>
<ID_SET>
<ID>1530241</ID>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
API Request
curl -S -H 'X-Requested-With:curl demo2' -u "USERNAME:PASSWORD" -d "action=list&details=Basic&ids=1505927" "https://<qualys_base_url>/api/2.0/fo/auth/oracle_http_server/"
XML Output
<<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_ORACLE_HTTP_SERVER_LIST_OUTPUT SYSTEM
"https://<qualys_base_url>/api/2.0/fo/auth/oracle_http_server/a
uth_oracle_http_server_list_output.dtd">
<AUTH_ORACLE_HTTP_SERVER_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2019-10-04T07:28:22Z</DATETIME>
<AUTH_ORACLE_HTTP_SERVER_LIST>
<AUTH_ORACLE_HTTP_SERVER>
<ID>1505927</ID>
<TITLE><![CDATA[Oracle_HTTP_Unix server]]></TITLE>
<IP_SET>
<IP>10.11.70.24</IP>
</IP_SET>
<UNIX>
<HOME_PATH><![CDATA[/opt/Oracle/Middleware/Oracle_WT1]]></HOME_PATH>
<DOMAIN_PATH><![CDATA[]]></DOMAIN_PATH>
<INST_PATH><![CDATA[/opt/Oracle/Middleware/Oracle_WT1/instances/instance1]]></INST_PATH>
<INST_NAME><![CDATA[ohs1]]></INST_NAME>
</UNIX>
<CREATED>
<DATETIME>2019-10-03T12:24:04Z</DATETIME>
<BY> john_doe</BY>
</CREATED>
<LAST_MODIFIED>
<DATETIME>2019-10-03T12:24:04Z</DATETIME>
</LAST_MODIFIED>
</AUTH_ORACLE_HTTP_SERVER>
</AUTH_ORACLE_HTTP_SERVER_LIST>
</RESPONSE>
</AUTH_ORACLE_HTTP_SERVER_LIST_OUTPUT>
<!-- CONFIDENTIAL AND PROPRIETARY INFORMATION. Qualys provides the
QualysGuard 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 2019, Qualys, Inc. //-
->
API Request
curl -S -H 'X-Requested-With:curl demo2' -u "USERNAME:PASSWORD" -d "action=list&details=All&ids=1505927" "https://<qualys_base_url>/api/2.0/fo/auth/oracle_http_server/"
XML Output
<<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_ORACLE_HTTP_SERVER_LIST_OUTPUT SYSTEM
"https://<qualys_base_url>/api/2.0/fo/auth/oracle_http_server/a
uth_oracle_http_server_list_output.dtd">
<AUTH_ORACLE_HTTP_SERVER_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2019-10-04T07:29:33Z</DATETIME>
<AUTH_ORACLE_HTTP_SERVER_LIST>
<AUTH_ORACLE_HTTP_SERVER>
<ID>1505927</ID>
<TITLE><![CDATA[Oracle_HTTP_Unix server]]></TITLE>
<IP_SET>
<IP>10.11.70.24</IP>
</IP_SET>
<UNIX>
<HOME_PATH><![CDATA[/opt/Oracle/Middleware/Oracle_WT1]]></HOME_PATH>
<DOMAIN_PATH><![CDATA[]]></DOMAIN_PATH>
<INST_PATH><![CDATA[/opt/Oracle/Middleware/Oracle_WT1/instances/instance1]]></INST_PATH>
<INST_NAME><![CDATA[ohs1]]></INST_NAME>
</UNIX>
<CREATED>
<DATETIME>2019-10-03T12:24:04Z</DATETIME>
<BY> john_doe</BY>
</CREATED>
<LAST_MODIFIED>
<DATETIME>2019-10-03T12:24:04Z</DATETIME>
</LAST_MODIFIED>
</AUTH_ORACLE_HTTP_SERVER>
</AUTH_ORACLE_HTTP_SERVER_LIST>
<GLOSSARY>
<USER_LIST>
<USER>
<USER_LOGIN> john_doe</USER_LOGIN>
<FIRST_NAME>John</FIRST_NAME>
<LAST_NAME>Doe</LAST_NAME>
</USER>
</USER_LIST>
</GLOSSARY>
</RESPONSE>
</AUTH_ORACLE_HTTP_SERVER_LIST_OUTPUT>
<!-- CONFIDENTIAL AND PROPRIETARY INFORMATION. Qualys provides the
QualysGuard 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 2019, Qualys, Inc. //-
->
API Request
curl -u "USERNAME:PASSWORD" -S -H 'X-Requested-With:curl demo2' -d "action=delete&ids=1507609" "https://<qualys_base_url>/api/2.0/fo/auth/oracle_http_server/"
XML Output
<<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM
"https://<qualys_base_url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2019-10-04T09:19:50Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Deleted</TEXT>
<ID_SET>
<ID>1507609</ID>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
<platform API server>/api/2.0/fo/auth/auth_records.dtd
<platform API server>/api/2.0/fo/auth/oracle_http_server/auth_oracle_http_server_list_output.dtd