Sybase record

/api/2.0/fo/auth/sybase/

[POST]

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 Parameters

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.

Sybase

 

port={value}

(Required to create record) The port where the database instance is running.

database={value}

(Required to create record) The name of the Sybase database you want to authenticate to.

port={value}

(Optional) The port where the database instance is running. Default is 5432.

installation_dir={value}

(Required for create request if this record will be used for scanning Unix hosts) The database installation directory for scanning Unix hosts.

Login Credentials

 

username={value}

(Required to create record, optional to update record) 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) The password of the Sybase account to be used for authentication. Maximum 100 characters (ascii).

login_type=vault

(To create record password or login_type=vault is required) 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) 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.

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) 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) 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) The network ID for the record.

 

Sample - 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://qualysapi.qualys.com/api/2.0/fo/auth/sybase/" > file.xml

XML output

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE BATCH_RETURN SYSTEM "https://qualysapi.qualys.com/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 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://qualysapi.qualys.com/api/2.0/fo/auth/sybase/" > file.xml

XML output

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE BATCH_RETURN SYSTEM "https://qualysapi.qualys.com/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 - 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://qualysapi.qualys.com/api/2.0/fo/auth/sybase/" > file.xml

DTDs for auth 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