Update a Network

Before you Begin

The user should have permission to view network entries.

Request Structure


Endpoint:	/certificate/discovery/networks
Type:	PUT
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
id	(Mandatory) ID of the network entry to be updated. Type: String
description	Description of the network entry. Type: String Constraints: description cannot exceed 500 characters. description must not have '<' character.
settings	(Optional) network setting that needs to be associated with the network entry. Note: The provided network settings must be available. Type: String
status	Status of the network entry. Type: Boolean
networks	(Optional) The list of network endpoints that needs to be updated in the network entry. Type: networks
network	(Mandatory) network to be added in the network entry. Note: Can have ip range, subnet, individual IP. Type: String
dataCenter	(Mandatory) dataCenter for the network. Note: The provided data center must be available. Type: String
sniHostname	(Optional) comma separated SNI Hostnames for the network. Type: String Constraints: sniHostname must not have '<' character.
onboardingGroupName	(Optional) Specifies the onboarding group to which the network will be assigned. Type: String Note: If not included, no changes are made to the current onboarding group selection. If the onboardingGroupName string is empty, the system automatically compares devices against all group rules and assigns them to the appropriate group.

Payload-Networks

Table 3. Payload
Name	Description
network	(Mandatory) network to be added in the network entry. Note: Can have ip range, subnet, individual IP. Type: String
dataCenter	(Mandatory) dataCenter for the network. Note: The provided data center must be available. Type: String
sniHostname	(Optional) comma separated SNI Hostnames for the network. Type: String Constraints: sniHostname must not have '<' character.

Response Structure

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

Table 4. Parameters
Name	Description
response	Contains the response for the group creation operation Type: Boolean
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

{
   "id": "683c3b3c0b80a91c95bea325",
   "description": "",
   "settings": "Default",
   "status": true,
   "networks": [
       {
           "network": "192.168.220.120",
           "dataCenter": "absecon",
           "sniHostname": "appviewx.com"
       }
   ]
}

Sample Response

{
   "response": "Success",
   "message": "Successfully updated the network",
   "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.