Sybase Record

For API version information, refer to the API Version History section.

V2.0

GET POST/api/2.0/fo/auth/sybase/

Create, update, list and delete Sybase records for authenticating to Sybase Adaptive Server Enterprise (ASE) instances. Compliance scans are supported (using PC).

Requirement - You must configure login credentials on target hosts before scanning.

Download Qualys User Guide - Sybase Authentication (.zip)

Tip - We strongly recommend you create one or more dedicated user accounts to be used solely by the Qualys Cloud Platform to authenticate to Sybase database instances.

Input ParametersInput Parameters

Parameter	Required/Optional	Data Type	Description
action={action}	Required	String	Specify create, update, delete (using POST) or list (using GET or POST). See List Auth Records for type
echo_request={0\|1}	Optional	Integer	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	Integer	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	String	A title for the record. The title must be unique. Maximum 255 characters (ascii).
comments={value}	Optional to create or update record	String	User defined comments. Maximum of 1999 characters.
Sybase
port={value}	Required to create record	Integer	The port where the database instance is running.
database={value}	Required to create record	Integer	The name of the Sybase database you want to authenticate to.
auto_discover_databases= {0\|1}	Required to create record	Integer	Specify auto_discover_databases=1 and we will find all Sybase database instances on the target host. This means you no longer have to create a separate Sybase record for each database name. Create one record with Auto Discover Databases enabled to authenticate to multiple databases on the same host. Note you must either enter a database name (with existing database parameter) OR use the Auto Discover option. When unspecified (auto_discover_databases=0), we will not auto discover database instances and look for the database name that you have entered in the database parameter
installation_dir={value}	Required for create request if this record will be used for scanning Unix hosts	Path	The database installation directory for scanning Unix hosts.
Login Credentials
username={value}	Required to create record, optional to update record	String	The username of the account to be used for authentication. If password is specified this is the username of a Sybase account. If login_type=vault is specified, this is the username of a vault account. Maximum 255 characters (ascii).
password={value}	To create record password or login_type=vault is required	String	The password of the Sybase account to be used for authentication. Maximum 100 characters (ascii).
password_encryption={0\|1}	Optional to create or update record	Integer	Enable this option when your Sybase database instance requires an encrypted password for successful login. If password encryption is required and you do not enable this option then authentication will fail. When set to 1, password encryption is enabled in the Sybase record.When set to 0 (the default), password encryption is not enabled.
login_type=vault	To create record password or login_type=vault is required	Integer	Set to vault if a third party vault will be used to retrieve password. Vault parameters need to be provided in the record. Click here for vault parameters
Target Hosts
ips={value}	Required to create record Optional to update record	Integer	The IP address(es) the server will log into using the record’s credentials. Multiple entries are comma separated. IPs specified will overwrite existing IPs in the record, and existing IPs will be removed. This parameter and the add_ips parameter or the remove_ips parameter cannot be specified in the same request.
add_ips={value}	Optional to update record	Integer	Add IPs and/or ranges to the IPs list for this record. Multiple IPs/ranges are comma separated. This parameter and the ips parameter cannot be specified in the same request.
remove_ips={value}	Optional to update record	Integer	IPs to be removed from your record. You may enter a combination of IPs and ranges. Multiple entries are comma separated. This parameter and the ips parameter cannot be specified in the same request.
network_id={value}	Optional to create or update record, and valid when the networks feature is enabled	Integer	The network ID for the record.

Sample - Create Sybase RecordSample - Create Sybase Record

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl Sample" -d "action=create&title=sybase_record&network_id=19015&username=acme_ac12&password=password&port=444&database=sybaseDB1&ips=10.10.24.12,10.10.24.13,10.10.24.15&installation_dir=/dir123&comments=This%20Sybase%20comments" "https://<qualys_base_url>/api/2.0/fo/auth/sybase/" > file.xml

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>2018-04-10T20:52:31Z</DATETIME>
    <BATCH_LIST>
      <BATCH>
        <TEXT>Successfully Created</TEXT>
        <ID_SET>
          <ID>78782</ID>
        </ID_SET>
      </BATCH>
    </BATCH_LIST>
  </RESPONSE>
</BATCH_RETURN>

Sample - Create Sybase Record, With VaultSample - Create Sybase Record, With Vault

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl Sample" -d "action=create&title=CYBERARK_DIGITAL_PIM_Vault_Sample&vault_id=139249&login_type=vault&vault_type=CyberArk%20PIM%20Suite&folder=Root&file=passwd_abc123&installation_dir=C://dir1/win/vault&username=Syb_User&port=456&database=Syb_db_Cyber-ArkSuite&ips=10.10.25.81-10.10.25.82&comments=sybase_vault_comments"
"https://<qualys_base_url>/api/2.0/fo/auth/sybase/" > file.xml

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>2018-04-13T18:54:36Z</DATETIME>
    <BATCH_LIST>
      <BATCH>
        <TEXT>Successfully Created</TEXT>
        <ID_SET>
          <ID>88888</ID>
        </ID_SET>
      </BATCH>
    </BATCH_LIST>
  </RESPONSE>
</BATCH_RETURN>

Sample - Create Sybase Record to Enable Password Encryption and Auto DiscoverySample - Create Sybase Record to Enable Password Encryption and Auto Discovery

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl Sample" -d "action=create&title=sybase_record&network_id=19015&username=acme_ ac12&password=&password_encryption=1&ips=10.10.24.12&aut o_discover_databases=1&port=444&installation_dir=/dir123&comments= This%20 Sybase%20comments" "https://<qualys_base_url>/api/2.0/fo/auth/sybase/" > file.xml

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM 
"http://<qualys_base_url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
 <RESPONSE>
 <DATETIME>2019-04-18T15:45:05Z</DATETIME>
 <BATCH_LIST>
 <BATCH>
 <TEXT>Successfully Created</TEXT>
 <ID_SET>
 <ID>43025</ID>
 </ID_SET>
 </BATCH>
 </BATCH_LIST>
 </RESPONSE>
</BATCH_RETURN>

Sample - Update Sybase RecordSample - Update Sybase Record

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl Sample" -d "action=update&ids=78782&add_ips=10.10.26.238&installation_dir=C://user/dir" "https://<qualys_base_url>/api/2.0/fo/auth/sybase/" > file.xml

Sample - List Sybase recordsSample - List Sybase records

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl Sample" -d "action=list&details=All" "https://<qualys_base_url>/api/2.0/fo/auth/sybase/" > file.xml

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_SYBASE_LIST_OUTPUT SYSTEM 
"https://<qualys_base_url>/api/2.0/fo/auth/sybase/auth_sybase_l
ist_output.dtd">
<AUTH_SYBASE_LIST_OUTPUT>
 <RESPONSE>
 <DATETIME>2017-04-10T21:32:21Z</DATETIME>
 <AUTH_SYBASE_LIST>
 <AUTH_SYBASE>
 <ID>78177</ID>
 <TITLE><![CDATA[api_syb_basic_2IPs_NW2]]></TITLE>
<USERNAME><![CDATA[api_user1]]></USERNAME>
 <DATABASE><![CDATA[api_sybDB1]]></DATABASE>
 <PORT>444</PORT>
 <IP_SET>
 <IP_RANGE>10.10.24.12-10.10.24.13</IP_RANGE>
 </IP_SET>
 <NETWORK_ID>19019</NETWORK_ID>
 <CREATED>
 <DATETIME>2017-04-08T00:17:17Z</DATETIME>
 <BY>enter_ss</BY>
 </CREATED>
 <LAST_MODIFIED>
 <DATETIME>2017-04-08T00:17:17Z</DATETIME>
 </LAST_MODIFIED>
 </AUTH_SYBASE>
 <AUTH_SYBASE>
 <ID>78186</ID>
 <TITLE><![CDATA[api_syb_basic_2IPs_Global]]></TITLE>
 <USERNAME><![CDATA[api_user1]]></USERNAME>
 <DATABASE><![CDATA[api_sybDB1]]></DATABASE>
 <PORT>444</PORT>
 <IP_SET>
 <IP_RANGE>10.10.24.12-10.10.24.13</IP_RANGE>
 </IP_SET>
 <NETWORK_ID>0</NETWORK_ID>
 <CREATED>
 <DATETIME>2017-04-08T01:10:04Z</DATETIME>
 <BY>enter_ss</BY>
 </CREATED>
 <LAST_MODIFIED>
 <DATETIME>2017-04-08T01:10:04Z</DATETIME>
 </LAST_MODIFIED>
 </AUTH_SYBASE>

DTDs for Authentication Type "sybase"

<platform API server>/api/2.0/batch_return.dtd

<platform API server>/api/2.0/fo/auth/sybase/auth_sybase_list_output.dtd

V3.0

GET POST/api/3.0/fo/auth/sybase/

Create, update, list and delete Sybase records for authenticating to Sybase Adaptive Server Enterprise (ASE) instances. Compliance scans are supported (using PC).

Requirement - You must configure login credentials on target hosts before scanning.

Download Qualys User Guide - Sybase Authentication (.zip)

Tip - We strongly recommend you create one or more dedicated user accounts to be used solely by the Qualys Cloud Platform to authenticate to Sybase database instances.

Input ParametersInput Parameters

Parameter	Required/Optional	Data Type	Description
action={action}	Required	String	Specify create, update, delete (using POST) or list (using GET or POST). See List Auth Records for type
echo_request={0\|1}	Optional	Integer	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	Integer	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	String	A title for the record. The title must be unique. Maximum 255 characters (ascii).
comments={value}	Optional to create or update record	String	User defined comments. Maximum of 1999 characters.
Sybase
port={value}	Required to create record	Integer	The port where the database instance is running.
database={value}	Required to create record	Integer	The name of the Sybase database you want to authenticate to.
auto_discover_databases= {0\|1}	Required to create record	Integer	Specify auto_discover_databases=1 and we will find all Sybase database instances on the target host. This means you no longer have to create a separate Sybase record for each database name. Create one record with Auto Discover Databases enabled to authenticate to multiple databases on the same host. Note you must either enter a database name (with existing database parameter) OR use the Auto Discover option. When unspecified (auto_discover_databases=0), we will not auto discover database instances and look for the database name that you have entered in the database parameter
installation_dir={value}	Required for create request if this record will be used for scanning Unix hosts	Path	The database installation directory for scanning Unix hosts.
ssl_verify={0\|1}	Optional	Boolean	SSL verification. 1 - If set to 1, verify if the certificate of the server is valid and that it can be trusted. 0 - If set to 0, no verification is required for the server certificate validation.
hosts = {value}	Required if ssl_verify=1	String	A list of FQDNs for all host IP addresses on which a custom SSL certificate signed by a trusted root CA is installed.
Login Credentials
username={value}	Required to create record, optional to update record	String	The username of the account to be used for authentication. If password is specified this is the username of a Sybase account. If login_type=vault is specified, this is the username of a vault account. Maximum 255 characters (ascii).
password={value}	To create record password or login_type=vault is required	String	The password of the Sybase account to be used for authentication. Maximum 100 characters (ascii).
password_encryption={0\|1}	Optional to create or update record	Integer	Enable this option when your Sybase database instance requires an encrypted password for successful login. If password encryption is required and you do not enable this option then authentication will fail. When set to 1, password encryption is enabled in the Sybase record.When set to 0 (the default), password encryption is not enabled.
login_type=vault	To create record password or login_type=vault is required	Integer	Set to vault if a third party vault will be used to retrieve password. Vault parameters need to be provided in the record. Click here for vault parameters
Target Hosts
ips={value}	Required to create record Optional to update record	Integer	The IP address(es) the server will log into using the record’s credentials. Multiple entries are comma separated. IPs specified will overwrite existing IPs in the record, and existing IPs will be removed. This parameter and the add_ips parameter or the remove_ips parameter cannot be specified in the same request.
add_ips={value}	Optional to update record	Integer	Add IPs and/or ranges to the IPs list for this record. Multiple IPs/ranges are comma separated. This parameter and the ips parameter cannot be specified in the same request.
remove_ips={value}	Optional to update record	Integer	IPs to be removed from your record. You may enter a combination of IPs and ranges. Multiple entries are comma separated. This parameter and the ips parameter cannot be specified in the same request.
network_id={value}	Optional to create or update record, and valid when the networks feature is enabled	Integer	The network ID for the record.

Sample - List Authentication RecordsSample - List Authentication Records

API Request

curl -k -s -S -H 'X-Requested-With:curl demo2' -u "johnd:PassW@123" -d "action=list&ids=5555555" "https://<qualys_base_url>/api/3.0/fo/auth/sybase/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_SYBASE_LIST_OUTPUT SYSTEM "https://<qualys_base_url>/api/3.0/fo/auth/sybase/auth_sybase_list_output.dtd">
<AUTH_SYBASE_LIST_OUTPUT>
    <RESPONSE>
        <DATETIME>2024-08-09T06:58:23Z</DATETIME>
        <AUTH_SYBASE_LIST>
            <AUTH_SYBASE>
                <ID>5555555</ID>
                <TITLE>
                    <![CDATA[sybase_auth_apiup]]>
                </TITLE>
                <USERNAME>
                    <![CDATA[abcup]]>
                </USERNAME>
                <DATABASE>
                    <![CDATA[dbup]]>
                </DATABASE>
                <PORT>67</PORT>
                <INSTALLATION_DIR>
                    <![CDATA[/opt/update]]>
                </INSTALLATION_DIR>
                <SSL_VERIFY>true</SSL_VERIFY>
                <HOSTS>
                    <HOST>
                        <![CDATA[agavaa]]>
                    </HOST>
                </HOSTS>
                <IP_SET>
                    <IP>1.1.1.1</IP>
                </IP_SET>
                <CREATED>
                    <DATETIME>2024-08-09T06:53:53Z</DATETIME>
                    <BY>jon_dre</BY>
                </CREATED>
                <LAST_MODIFIED>
                    <DATETIME>2024-08-09T06:56:43Z</DATETIME>
                </LAST_MODIFIED>
            </AUTH_SYBASE>
        </AUTH_SYBASE_LIST>
    </RESPONSE>
</AUTH_SYBASE_LIST_OUTPUT>

Sample - Create Authentication RecordsSample - Create Authentication Records

API Request

curl -k -s -S -H 'X-Requested-With:curl demo2' -u "johnd:PassW@123" -d "action=create&title=sybase_auth_api&username=jon&password=passw@123&database=db&port=67&ips=1.1.1.1&ssl_verify=1&hosts=abc.com,qa&installation_dir=/opt" "https://<qualys_base_url>/api/3.0/fo/auth/sybase/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "https://<qualys_base_url>/api/3.0/batch_return.dtd">
<BATCH_RETURN>
    <RESPONSE>
        <DATETIME>2024-08-09T06:53:53Z</DATETIME>
        <BATCH_LIST>
            <BATCH>
                <TEXT>Successfully Created</TEXT>
                <ID_SET>
                    <ID>5555555</ID>
                </ID_SET>
            </BATCH>
        </BATCH_LIST>
    </RESPONSE>
</BATCH_RETURN>

Sample - Update Authentication RecordsSample - Update Authentication Records

API Request

curl -k -s -S -H 'X-Requested-With:curl demo2' -u "johnd:PassW@123" -d "action=update&title=sybase_auth_apiupdate&username=abcupdate&password=123m&database=dbupdate&port=677&ids=5256516&ssl_verify=1&hosts=abc.com" "https://<qualys_base_url>/api/3.0/fo/auth/sybase/" >

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "https://<qualys_base_url>/api/3.0/batch_return.dtd">
<BATCH_RETURN>
    <RESPONSE>
        <DATETIME>2024-08-05T06:13:55Z</DATETIME>
        <BATCH_LIST>
            <BATCH>
                <TEXT>Successfully Updated</TEXT>
                <ID_SET>
                    <ID>5555555</ID>
                </ID_SET>
            </BATCH>
        </BATCH_LIST>
    </RESPONSE>
</BATCH_RETURN>

Sample - Delete Authentication RecordsSample - Delete Authentication Records

API Request

curl -k -s -S -H 'X-Requested-With:curl demo2' -u "johnd:PassW@123" -d "action=delete&ids=5555555" "https://<qualys_base_url>/api/3.0/fo/auth/sybase/"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "https://<qualys_base_url>/api/3.0/batch_return.dtd">
<BATCH_RETURN>
    <RESPONSE>
        <DATETIME>2024-08-05T06:37:28Z</DATETIME>
        <BATCH_LIST>
            <BATCH>
                <TEXT>Successfully Deleted</TEXT>
                <ID_SET>
                    <ID>5555555</ID>
                </ID_SET>
            </BATCH>
        </BATCH_LIST>
    </RESPONSE>
</BATCH_RETURN>

DTDs for Authentication Type "sybase"

<platform API server>/api/3.0/batch_return.dtd

<platform API server>/api/3.0/fo/auth/sybase/auth_sybase_list_output.dtd

API Version History

The following table depicts the information about the different versions of this API along with the status:

API Version	API Status	Release Date
/api/2.0/fo/auth/sybase/	To be deprecated	March 2025
/api/3.0/fo/auth/sybase/	Active	September 2024