Update Web Proxy

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

Request

URI

PUT

https://{api_host}/api/ni/settings/proxy-servers/{id}

COPY

Path Parameters

string

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.

ApiKeyAuth

Responses

204

Success

Operation doesn't return any data structure

401

Unauthorized

Returns ApiError of type(s) application/json

"ApiError Object"

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of object

details

Optional

details

404

Not Found

Returns ApiError of type(s) application/json

"ApiError Object"

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of object

details

Optional

details

409

Conflict

Returns ApiError of type(s) application/json

"ApiError Object"

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of object

details

Optional

details

500

Internal Error

Returns ApiError of type(s) application/json

"ApiError Object"

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of object

details

Optional

details

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/ni/settings/proxy-servers/{id}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Settings Operations

GET

Get Ip Tag Ids