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

Get Web Proxy

Description

Get details of an existing Web Proxy Server. Only admin and audit users can perform this action.

Request

Request

URL

URL


get
https://vrni.example.com/api/ni/settings/proxy-servers/{id}
Copy

Path Parameters

Path Parameters

string
id Required

The Entity ID of object requestion information on


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ProxyResponse of type(s) application/json
{
    "auth_type": "Basic/NTLM",
    "connected_entities": 3,
    "is_modifiable": "true/false",
    "nick_name": "AWS web Proxy",
    "proxy_id": "web-proxy-er67ght8kn67",
    "proxy_type": "HTTPS/HTTP",
    "target_ip": "10.11.11.102",
    "target_port": 161,
    "use_credentials": "true/false",
    "user_name": "admin"
}
string
auth_type Optional

Type of authentication


integer
connected_entities Optional

Number of connected entities to a web proxy


boolean
is_modifiable Optional

Can the web proxy be edited or deleted from the UI


string
nick_name Optional

Descriptor or identifier for particular web proxy.


string
proxy_id Optional

Entity Identifier for a web proxy server


string
proxy_type Optional

Type of web proxy


string
target_ip Optional

IP address of web Proxy server


integer
target_port Optional

Port number of web Proxy server


boolean
use_credentials Optional

Whether credentials were used earlier when web proxy was configured


string
user_name Optional

Username of the authenticated web proxy

Errors

Errors

ApiError
401

Unauthorized


ApiError
404

Not Found


ApiError
500

Internal Error

Code Samples

Code Samples

cURL Command

curl https://vrni.example.com/api/ni/settings/proxy-servers/{id}


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

Was this page helpful?