Add Web Proxy

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

Request

URI

POST

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

COPY

Request Body

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

201

Success

Returns ProxyProfileIdResponse of type(s) application/json

"ProxyProfileIdResponse Object"

string

proxy_id

Optional

Entity Identifier created for the newly configured web proxy server

400

Bad Request

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

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

403

Forbidden

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 POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/ni/settings/proxy-servers

On This Page

Description

Request

Request Body

Authentication

Response

201 Response Body

Errors

Settings Operations

GET

Get Ip Tag Ids

Deprecated