List Networks
Click here to see this page in full context

List Networks

GET POST/api/2.0/fo/network/?action=list

List custom networks in your account.

Permissions - This API is available to all users with the API access permission. A Manager will view all custom networks in the subscription, a Unit Manager will view custom networks in their business unit’s assigned asset groups, and a Scanner/Reader will view custom networks in their account’s assigned asset groups.

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action=list

 Required String 

Specify action=list to list the networks.

echo_request={0|1}

 Optional Integer 

Specify 1 to show (echo) the request’s input parameters (names, values) in the XML output.

ids={value1,value2}

 Optional Integer 

Filter the list to view specific networks.

Sample - List Custom NetworksSample - List Custom Networks

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl" "https://<qualys_base_url>/api/2.0/fo/network/?action=list&ids=7343,7345,7350"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE NETWORK_LIST SYSTEM "https://<qualys_base_url>/api/2.0/fo/network/network_list_output.dtd">
<RESPONSE>
  <DATETIME>2018-05-28T01:06:45Z</DATETIME>
  <NETWORK_LIST>
    <NETWORK>
      <ID>7343</ID>
      <NAME><![CDATA[My New Network]]></TITLE>
      <SCANNER_APPLIANCE_LIST>
        <SCANNER_APPLIANCE>
          <ID>1234</ID>
          <FRIENDLY_NAME><![[CDATA[abc123]]></FRIENDLY_NAME>
        </SCANNER_APPLIANCE>
      </SCANNER_APPLIANCE_LIST>
    </NETWORK>
    ...
  </NETWORK_LIST>
</RESPONSE>

DTD

<platform API server>/api/2.0/fo/network/network_list_output.dtd