Update Web Proxy

Update Web Proxy

Update the details of an existing Web Proxy Server. Only admin can perform this action.

Request
URI
PUT
https://www.mgmt.cloud.vmware.com/ni/api/ni/settings/proxy-servers/{id}
COPY
Path Parameters
string
id
Required

The Entity ID of object requestion information on

Request Body

Updated Web Proxy Details

WebProxyRequest of type(s) application/json
Required 
{
    "nick_name": "AWS web Proxy",
    "target_ip": "10.11.11.102",
    "target_port": 161,
    "proxy_type": "HTTP",
    "auth_type": "Basic/NTLM",
    "use_credentials": true,
    "user_name": "admin",
    "password": "admin"
}
string
nick_name
Optional

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

string
target_ip
Optional

IP address of web Proxy server

integer
target_port
Optional

Port number of web Proxy server

string
proxy_type
Optional

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

string
auth_type
Optional

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

boolean
use_credentials
Optional

Credentials required for this web proxy

string
user_name
Optional

Username for web proxy authentication

string
password
Optional

Password for web proxy authentication

Authentication
This operation uses the following authentication methods.
Responses
204

Success

Operation doesn't return any data structure

401

Unauthorized

Returns ApiError of type(s) application/json 
{
    "code": "integer",
    "message": "string",
    "details": [
        {
            "code": "integer",
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


404

Not Found

Returns ApiError of type(s) application/json 
{
    "code": "integer",
    "message": "string",
    "details": [
        {
            "code": "integer",
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


409

Conflict

Returns ApiError of type(s) application/json 
{
    "code": "integer",
    "message": "string",
    "details": [
        {
            "code": "integer",
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


500

Internal Error

Returns ApiError of type(s) application/json 
{
    "code": "integer",
    "message": "string",
    "details": [
        {
            "code": "integer",
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


On This Page
Settings Operations
POST
Add new SNMP Trap destination profile
DELETE
Delete An existing SNMP Trap destination profile
GET
Get details Of An existing SNMP destination profile
GET
List the configured SNMP Trap destination profiles
POST
Migrate event subscriptions To other SNMP Trap destination profiles
POST
Send Test trap To SNMP destination profile
PUT
Update An existing SNMP destination profile
PUT
Update user password
POST
Add Backup Config
POST
Add Ip Tag
POST
Add Restore Config
POST
Add Search Based Alert Config
POST
Add Syslog Target
POST
Add Tag V2
POST
Add Web Proxy
POST
Create Subnet Mapping
POST
Create Subscriber
POST
Create User Defined Event
DELETE
Delete Backup Config
DELETE
Delete Restore Config
DELETE
Delete Search Based Alert Config
DELETE
Delete Subnet Mapping
DELETE
Delete Subscriber
DELETE
Delete Syslog Target
DELETE
Delete User Defined Event
DELETE
Delete Web Proxy
POST
Disable Search Based Alert Config
POST
Disable User Defined Event
POST
Enable Search Based Alert Config
POST
Enable User Defined Event
GET
Get All Search Based Alert Configs
GET
Get All Subscriber
GET
Get All User Defined Events
GET
Get Backup Config
GET
Get Backup Status Report
GET
Get Connected Clients To Web Proxy
GET
Get Infra Nodes Web Proxy
GET
Get Ip Tag
GET
Get Ip Tag Ids
GET
Get Ip Tag V2
GET
Get Restore Config
GET
Get Restore Status Report
GET
Get Search Based Alert Config
GET
Get Subnet Mappings
GET
Get Subscriber
GET
Get Syslog Mapping
GET
Get Syslog Status
GET
Get Syslog Target List
GET
Get Tag Ids V2
GET
Get User Defined Event
GET
Get Web Proxies
GET
Get Web Proxy
POST
Remove Ip Tag
POST
Remove Tag V2
POST
Send Syslog Test Message
PUT
Update Backup Config
PUT
Update Search Based Alert Config
PUT
Update Subnet Mapping
PUT
Update Subscriber
POST
Update Syslog Mapping
PATCH
Update Syslog Status
PUT
Update Syslog Target
PUT
Update User Defined Event
PUT
Update Web Proxy
POST
Validate Connections Via Web Proxy
POST
Validate Web Proxy Migration