[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

Add Web Proxy

Description

Add new Web Proxy server. By Default, maximum of 10 web proxy servers can be configured. Only admin users can perform this action.

Request

Request

URL

URL


post
https://vrni.example.com/api/ni/settings/proxy-servers
Copy

Request Body

Request Body

WebProxyRequest of type(s) application/json Required

Web Proxy Details

{
    "auth_type": "Basic/NTLM",
    "nick_name": "AWS web Proxy",
    "password": "admin",
    "proxy_type": "HTTP",
    "target_ip": "10.11.11.102",
    "target_port": 161,
    "use_credentials": true,
    "user_name": "admin"
}
string
auth_type Optional

Type of authentication. [Permitted Values - Basic/NTLM]


string
nick_name Optional

Descriptor or identifier for particular web proxy. It should be unique


string
password Optional

Password for web proxy authentication


string
proxy_type Optional

Type of web Proxy being configured. [Permitted Values - HTTP/HTTPS]


string
target_ip Optional

IP address of web Proxy server


integer
target_port Optional

Port number of web Proxy server


boolean
use_credentials Optional

Credentials required for this web proxy


string
user_name Optional

Username for web proxy authentication

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

Returns ProxyProfileIdResponse of type(s) application/json
{
    "proxy_id": "web-proxy-er67ght8kn67"
}
string
proxy_id Optional

Entity Identifier created for the newly configured web proxy server

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


500

Internal Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"auth_type":"Basic/NTLM","nick_name":"AWS web Proxy","password":"admin","proxy_type":"HTTP","target_ip":"10.11.11.102","target_port":161,"use_credentials":true,"user_name":"admin"}' https://vrni.example.com/api/ni/settings/proxy-servers


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Settings Operations
Feedback

Was this page helpful?