Neo4j record

/api/2.0/fo/auth/neo4j/

[POST]

Create, update, list, and delete Neo4j records for compliance scans (using PC).Compliance scans are supported (using PC).

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

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).

vault_id={value}

(Required if login_type=vault) The ID of the vault to be used to retrieve the password for login.

vault_type={value}

(Required if login_type=vault) The third party vault to be used to retrieve the password for login. Certain vaults support this capability. See “Vault Support Matrix” in the API user guide.

ips={value}

(Required to create record) Enter a combination of IPs and IP ranges to identify compliance hosts. Multiple entries are comma separated.

add_ips={value}

(Optional and valid only to update record) Add IPs to the IP list for an existing record. You may enter a combination of IPs and IP ranges. Multiple entries are comma separated.

remove_ips={value}

(Optional and valid only to update record) IPs to be removed from your record. You may enter a combination of IPs and ranges. Multiple entries are comma separated.

database={value}

(Optional to create or update record) The database name of the Neo4j database to be scanned. The database name may contain a maximum of 255 multi-byte characters.

port={value}

(Required to create record, optional to update record) The port number assigned to the database instance to be scanned.

username={value}

(Required to create record, optional to update record) The username to be used for authentication to Neo4j.

login_type={basic|vault}

(Optional) The login type is basic by default. You can choose vault (for vault based authentication).

password={value}

(Required to create record) When login_type=basic, specify the password to be used for authentication to Neo4j. Maximum 100 characters (ascii).

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 In Servers that don’t use SSL or Neo4j 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 Neo4j server uses SSL, the server SSL certificate is valid and matches the scanned host.

hosts={value}

(Required only when ssl_verify is enabled) 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.

neo4j_version={value}

(Optional) Specifies the Neo4j version. Only Neo4j 3.x version is supported at this time. Valid value is “neo4j 3.x” (case insensitive). When unspecified, Neo4j 3.x is used.

unix_base_path={value}

(Optional) The base path for Neo4j on your Unix hosts. Sample value: /opt/neo4j-enterprise-3.5.16/

Instead of specifying the path information, you can choose to auto discover the base and configuration paths by specifying neo4j_auto_path=1.

unix_conf_path={value}

(Optional) The path to the Neo4j configuration file on your Unix hosts. Sample value: /opt/neo4j-enterprise- 3.5.16/conf/neo4j.conf

Note that the configuration file must be in the same location for all hosts (IPs) included in the record. Instead of specifying path information, you can choose to auto discover the base and configuration paths by specifying neo4j_auto_path=1.

neo4j_auto_path={0|1}

(Optional) When unspecified or neo4j_auto_path=0 (false), we will not use auto discovery to find the base and configuration paths for Neo4j on your Unix hosts. Use the unix_base_path and unix_conf_path input parameters to specify path information.

When neo4j_auto_path=1 (true) we will auto discover the base and configuration paths for Neo4j on your Unix hosts.

 

Sample - Create Neo4j record

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl" -d

"action=create&title=neo4j-recordAuth Record&username=root&password=root1&database=graph.db&port=7687&ips=1.1.14&unix_conf_path=/opt/neo4j-enterprise-3.5.16/conf/neo4j.conf&unix_base_path=/opt/neo4j-enterprise-3.5.16/&neo4j_version=neo4j 3.x&neo4j_auto_path=0"

"https://qualysapi.qualys.com/api/2.0/fo/auth/neo4j/"

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>2021-03-15T11:56:08Z</DATETIME>

    <BATCH_LIST>

      <BATCH>

        <TEXT>Successfully Created</TEXT>

        <ID_SET>

          <ID>101430</ID>

        </ID_SET>

      </BATCH>

    </BATCH_LIST>

  </RESPONSE>

</BATCH_RETURN>

Sample - Update Neo4j record

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl" -d

"action=update&title=Neo4j Auth Record &username=root&password=root1&database=graph.db&port=7689&ips=1.1.1.1&ids=101430&unix_conf_path=/opt/neo4j-enterprise-3.5.16/conf/neo4j.conf&unix_base_path=/opt/neo4j-enterprise-3.5.16/&neo4j_version=neo4j 3.x&neo4j_auto_path=0"

"https://qualysapi.qualys.com/api/2.0/fo/auth/neo4jl/"

 

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>2021-03-15T11:56:08Z</DATETIME>

        <BATCH_LIST>

            <BATCH>

                <TEXT>Successfully Updated</TEXT>

                <ID_SET>

                    <ID>101430</ID>

                </ID_SET>

            </BATCH>

        </BATCH_LIST>

    </RESPONSE>

</BATCH_RETURN>

Sample - Delete Neo4j record

API request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl" -d

"action=delete&ids=4620768" "https://qualysapi.qualys.com/api/2.0/fo/auth/neo4j/"

 

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>2021-04-01T13:12:51Z</DATETIME>

    <BATCH_LIST>

      <BATCH>

        <TEXT>Successfully Deleted</TEXT>

        <ID_SET>

          <ID>4620768</ID>

        </ID_SET>

      </BATCH>

    </BATCH_LIST>

  </RESPONSE>

</BATCH_RETURN>