/api/2.0/fo/auth/informixdb/
[POST]
Create, update, list and delete InformixDB authentication records. Compliance scans are supported (using PC). Unix authentication is required for compliance scans using the PC app.
Requirement - The IP addresses you define in your InformixDB records must be defined in Unix records.
We strongly recommend you create one or more dedicated user accounts to be used solely by the Qualys Cloud Platform to authenticate to InformixDB instances.
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 to update or delete record) Record IDs to update/delete. Specify record IDs and/or ID ranges (for example, 1359-1407). Multiple entries are comma separated. |
title={value} |
(Required to create record) A title for the record. The title must be unique. Maximum 255 characters (ascii). |
comments={value} |
(Optional to create or update record) User defined comments. Maximum of 1999 characters. |
InformixDB |
|
ssl_verify={0|1} |
(Optional to create or update record, and valid for server that supports SSL) Specify 1 for a complete SSL certificate validation. - If ssl_verify=0, the Qualys scanners authenticate with Informix Servers that don’t use SSL or InformixDB servers that use SSL. However, in the SSL case, the server SSL certificate verification will be skipped. - If unspecified (or ssl_verify=1), the Qualys scanners will only send a login request after verifying that a connection to the InformixDB server uses SSL, the server SSL certificate is valid and matches the scanned host. |
hosts={value} |
(Optional to create or update record) A list of FQDNs for the hosts that correspond to all host IP addresses on which a custom SSL certificate signed by a trusted root CA is installed. Multiple hosts are comma separated. |
database={value} |
(Required to create record, optional to update record) The database name to authenticate to. Specify a valid InformixDB database name. Maximum 255 characters. |
port={value} |
(Required to create record, optional to update record) The port the database name is running on. Valid range is 1-65535. The standard port for InformixDB is 1526. |
unix_config_dir= |
(Optional to create or update record) The path to the Unix informixdb installation directory. Access to this directory is required to run certain checks on Unix hosts. |
unix_on_config_dir={value} |
(Optional to create or update record) The absolute path to the Unix file that contains configuration parameters of the database server. |
unix_sql_host_dir={value} |
(Optional to create or update record) The absolute path to the Unix file that contains database connectivity information. |
Login credentials |
|
login_type={basic} |
(Optional) The login type is basic by default. We are not supporting vault based authentication. |
username={value} |
(Required to create record, optional to update record) The username to be used for authentication to InformixDB server. |
password={value} |
(Required to create record, optional to update record) The password to be used for authentication to InformixDB server. Maximum 100 characters (ascii). |
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 sample" -d
"action=create&title=my-informixdb-record&username=informix-admin&password=test123&ips=10.10.10.11&comments=informix-basic-ipv4&unix_config_dir=/opt/informix/&port=1526&ssl_verify=0&unix_on_config_dir=/opt/Informix/etc/onconfig.demo&unix_sql_host_dir=opt/Informix/etc/sqlhosts.demo&database_name=dbname&login_type=basic"
"https://qualysapi.qualys.com/api/2.0/fo/auth/informixdb/"
XML output
<BATCH_RETURN>
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "http://qualysapi.qualys.com/api/2.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2019-01-30T15:45:05Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Created</TEXT>
<ID_SET>
<ID>43025</ID>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
API request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl sample" -d
"action=create&title=my-informixdb-record&username=informix-admin&password=test123&ips=10.10.10.11&comments=informix-basic-ipv4&unix_config_dir=/opt/informix/&port=1526&ssl_verify=1&unix_on_config_dir=/opt/Informix/etc/onconfig.demo&unix_sql_host_dir=opt/Informix/etc/sqlhosts.demo&database_name=dbname&login_type=basic&hosts=mlinformixdb32e.s2012r2.qualys.com,mlinformixdb32e.s2008r2.rdlab.qualys.com"
"https://qualysapi.qualys.com/api/2.0/fo/auth/informixdb/"
XML output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "http://qualysapi.qualys.com/api/2.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2019-01-30T15:47:01Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Created</TEXT>
<ID_SET>
<ID>43026</ID>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
API request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl" -d
"action=list&details=Basic"
"https://qualysapi.qualys.com/api/2.0/fo/auth/informixdb/"
XML output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_INFORMIXDB_LIST_OUTPUT SYSTEM "https://qualysapi.qualys.com/fo/auth/informixdb/auth_informixdb_list_output.dtd">
<AUTH_INFORMIXDB_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2019-01-30T15:19:02Z</DATETIME>
<AUTH_INFORMIXDB_LIST>
<AUTH_INFORMIXDB>
<ID>40034</ID>
<TITLE><![CDATA[InformixDB1]]></TITLE>
<USERNAME><![CDATA[root]]></USERNAME>
<DATABASE><![CDATA[informixdb]]></DATABASE>
...
</AUTH_INFORMIXDB>
</AUTH_INFORMIXDB_LIST>
</RESPONSE>
</AUTH_INFORMIXDB_LIST_OUTPUT><!DOC
API request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl sample" -d
"action=update&ids=41026&title=API-informixdb-basic-login-updated&username=admin-updated-again&password=updated-password&database_name=new-admin&comments=informixdb-basic-login-ipv4-updated&unix_config_dir=/opt/informixdb/updated/again"
"https://qualysapi.qualys.com/api/2.0/fo/auth/informixdb/"
XML output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "http://qualysapi.qualys.com/api/2.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2019-01-30T16:00:16Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Updated</TEXT>
<ID_SET>
<ID>43025</ID>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
API request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl sample" -d
"action=delete&ids=43023,43024"
"https://qualysapi.qualys.com/api/2.0/fo/auth/informixdb/"
XML output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "http://10.114.69.159:46445/api/2.0/batch_return.dtd">
<BATCH_RETURN>
<RESPONSE>
<DATETIME>2019-01-30T15:41:46Z</DATETIME>
<BATCH_LIST>
<BATCH>
<TEXT>Successfully Deleted</TEXT>
<ID_SET>
<ID_RANGE>43023-43024</ID_RANGE>
</ID_SET>
</BATCH>
</BATCH_LIST>
</RESPONSE>
</BATCH_RETURN>
<platform API server>/api/2.0/batch_return.dtd
<platform API server>/api/2.0/fo/auth/informixdb/auth_informixdb_list_output.dtd