List a Network

The API lists the network entries in discovery configuration based on the payload.

Before you Begin

The user should have permission to view network entries.

Request Structure


Endpoint:	/certificate/discovery/networks
Type:	POST
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/certificate/group?gwsource=external` To understand the elements of the sample URL, click here.
Headers
Content-Type:	application/json

Table 1. Input Parameters
Name	Description
username `Header`	(Mandatory) Username for logging in to AppViewX. Type: String
password `Header`	(Mandatory) Password for logging in to AppViewX. Type: String
Content-Type `Header`	(Mandatory) Payload content-type with application/json value. Type: String Constraint: The value must be application/json.
gwsource `Query`	(Mandatory) Source from which the request is triggered. (For example. external) Type: String
Payload `Body`	Contains all the parameters to be included in the request body for the POST request. Type: Payload

Payload

Table 2. Payload
Name	Description
start	(Optional) Specifies the zero-based index of the first item to return. Type: Integer Constraint: start must not be negative Default: Zero (0).
max	(Optional) Specifies the maximum number of items to return. Type: Integer Constraints: max must not be negative Default: 100 (if the provided value exceeds 100).
filter	(Optional) Free text search to filter the list of networks. Type: String
sortColumn	(Optional) Specifies the field by which to sort the results. Type: String Possible Value(s): "name", "description", "scheduledDiscovery", "onDemandDiscovery", "dataCenter", "settings" Default: name
sortOrder	(Optional) Defines the sort direction. Type: String Possible Value(s): Must be one of “asc” or “desc”.

Response Structure

Response returns string of type application/json with the following body parameters:

Table 3. Parameters
Name	Description
response	Contains the response for the group creation operation Type: Boolean
search	The search string entered in the “filter” field of payload. Type: String
totalRecords	The total network entries present in the database for the free text search filter. Type: long
data	Contains the list of network entries. Type: List
id	Unique identifier for the network entry. Type: String
name	Name of the network entry. Type: String
description	Description of the network entry. Type: String
status	Status of the network entry. Type: Boolean
readOnly	Read only access for the network entry. Type: Boolean
createdDate	Creation date of the network entry. Type: Long
updatedDate	Updation date of the network entry. Type: Long
createdBy	User who created the network entry. Type: String
updatedBy	User who updated the network entry. Type: String
settings	Network setting associated with the network entry. Type: String
scheduledDiscovery	List of scheduled discovery names done with the network entry. Type: List
onDemandDiscovery	List of ondemand discovery names done with the network entry. Type: List
dataCenter	List of datacenter for the network entry. Type: List
executionTime	Indicates the time at which the execution was triggered. Type: Long
iTotalDisplayRecords	The total network entries present in the database for the free text search filter. Type: Long
message	Success message or failure description in case of error. Failure: Returns the Failure message Type: String
appStatusCode	Application specific status code for the response. It is a non-null value for a failure response. Type: String
tags	Additional information in case of failure response.

Status Codes


HTTP Code	appStatusCode	Response Message
202 Accepted	null	Reissue action has been triggered successfully
401 Unauthorized	AVX_GW_003	Authentication failed, reason - Invalid Credentials. Remediation: Ensure that valid username and password or a valid sessionId is provided as header parameters.
404 Not Found	NO_RECORDS_FOUND	No matching records found. Remediation: Check and ensure that the values provided for commonName / serialNumber / resourceId are correct.
400 Bad Request	INVALID_REQUEST	Please give valid common name and serial number or resourceId. Remediation: Provide a valid commonName and serialNumber or resourceId.
400 Bad Request	INVALID_REQUEST	Please provide a valid action. Remediation: Provide a valid action.
400 Bad Request	MANDATORY_FIELD_MISSING	Mandatory field is missing or invalid - action. Remediation: Ensure that the action field is available in the request payload.
417 Expectation failed	CERT-GRP-0001	Group already exists with the given name Remediation: Ensure that the group name is unique and not a duplicate of an existing group.
400 Bad Request	CERT-PLCY-0009	Policy name is invalid. Remediation: Ensure that the policy name is valid.

Sample Request/Response

Sample Request

{
   "start" : 0,
   "max" : 10,
   "filter" : "",
   "sortColumn":"name",
   "sortOrder":"desc"
}

Sample Response

{
   "response": {
       "search": "",
       "totalRecords": 2,
       "data": [
           {
               "id": "683c38170b80a91c95bea252",
               "name": "test-networks12",
               "description": "network to be added",
               "status": true,
               "readOnly": false,
               "createdDate": 1748776983876,
               "updatedDate": 1748776983876,
               "createdBy": "admin",
               "updatedBy": "admin",
               "settings": "Default",
               "scheduledDiscovery": [],
               "onDemandDiscovery": [],
               "dataCenter": [
                   "absecon"
               ],
               "ids": null
           }
       ],
       "autoSuggest": null,
       "executionTime": 1748779898,
       "iTotalDisplayRecords": 2
   },
   "message": "Networks are listed",
   "appStatusCode": null,
   "tags": {},
   "headers": null
}

References

Understanding the sample URL

IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
- IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication
  The IP address will be included in the endpoint URL for an on-prem deployment.
- HostName: A human-readable label assigned to a device (host) on a network
  The hostname will be included in the endpoint URL for an on-prem deployment.
- TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify
  The tenant name will be included in the endpoint URL for a SaaS deployment.
GWPORT: AppViewX gateway port
A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.
Example: 31443
avxapi: Path parameter value (static) that is part of the endpoint's URL
Endpoint: Endpoint of the API, for example: execute-hook
gwsource: Source or origin of a gateway, for example: external.