Nginx record

/api/2.0/fo/auth/nginx/

[POST]

Create, update, list, and delete Nginx 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).

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.

unix_base_path={value}

(Optional) Absolute path of the Nginx binary file location.

unix_conf_path={value}

(Optional) The path to the Nginx configuration file on your Unix hosts.

unix_prefix_path

(Optional) The path to the Nginx configuration file on your Unix hosts.

 

Sample - Create Nginx record

API request

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

"action=create&ips=1.2.3.4&

title=API_Nginx&unix_bin_path=/usr/local/nginx/sbin/nginx&unix_conf_path=/usr/local/nginx/conf/nginx.conf

&unix_prefix_path=/usr/local/nginx" "https://qualysapi.qualys.com/api/2.0/fo/auth/nginx/"

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-08-13T11:36:30Z</DATETIME>

    <BATCH_LIST>

      <BATCH>

        <TEXT>Successfully Created</TEXT>

        <ID_SET>

          <ID>1157719</ID>

        </ID_SET>

      </BATCH>

    </BATCH_LIST>

  </RESPONSE>

</BATCH_RETURN>

Sample - Update Nginx record

API request

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

"action=update&ids=229028&ips=10.10.10.10&title=Test Nginx&unix_bin_path=/usr/local/nginx/sbin/nginx&unix_conf_path=/usr/local/nginx/conf/nginx.conf&unix_prefix_path=/usr/local/nginx"

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

 

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-08-03T03:15:35Z</DATETIME>

        <BATCH_LIST>

            <BATCH>

                <TEXT>Successfully Updated</TEXT>

                <ID_SET>

                    <ID>229028</ID>

                </ID_SET>

            </BATCH>

        </BATCH_LIST>

    </RESPONSE>

</BATCH_RETURN>

Sample - Delete Nginx record

API request

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

"action=delete&ids=5146728,5146726" "https://qualysapi.qualys.com/api/2.0/fo/auth/nginx/""

 

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-08-27T11:38:07Z</DATETIME>

    <BATCH_LIST>

      <BATCH>

        <TEXT>Successfully Deleted</TEXT>

        <ID_SET>

          <ID>5146726</ID>

          <ID>5146728</ID>

        </ID_SET>

      </BATCH>

    </BATCH_LIST>

  </RESPONSE>

</BATCH_RETURN>