Get Web Proxy

Get Web Proxy

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

Request
URI
GET
https://vrni.example.com/api/ni/settings/proxy-servers/{id}
COPY
Path Parameters
string
id
Required

The Entity ID of object requestion information on

Authentication
This operation uses the following authentication methods.
Responses
200

OK

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

Entity Identifier for a web proxy server

string
nick_name
Optional

Descriptor or identifier for particular web proxy.

string
target_ip
Optional

IP address of web Proxy server

integer
target_port
Optional

Port number of web Proxy server

integer
connected_entities
Optional

Number of connected entities to a web proxy

string
proxy_type
Optional

Type of web proxy

string
auth_type
Optional

Type of authentication

boolean
use_credentials
Optional

Whether credentials were used earlier when web proxy was configured

string
user_name
Optional

Username of the authenticated web proxy

boolean
is_modifiable
Optional

Can the web proxy be edited or deleted from the UI


401

Unauthorized

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "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": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "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": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "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
Activate Serial Number
POST
Add new SNMP Trap destination profile
POST
Add Backup Config
POST
Add Ip Tag
POST
Add Restore Config
POST
Add Search Based Alert Config
POST
Add Vidm User
POST
Add Vidm User Group
POST
Add Web Proxy
POST
Create Subnet Mapping
POST
Create Subscriber
POST
Create User Defined Event
DELETE
Deactivate Serial Number
DELETE
Delete An existing SNMP Trap destination profile
DELETE
Delete Backup Config
DELETE
Delete Restore Config
DELETE
Delete Search Based Alert Config
DELETE
Delete Subnet Mapping
DELETE
Delete Subscriber
DELETE
Delete User
DELETE
Delete User Defined Event
DELETE
Delete User Group
DELETE
Delete Vidm Configuration
DELETE
Delete Web Proxy
POST
Disable Search Based Alert Config
POST
Disable User Defined Event
POST
Disable Vidm
POST
Enable Search Based Alert Config
POST
Enable User Defined Event
POST
Enable Vidm
GET
Get details Of An existing SNMP destination profile
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 Certificate
GET
Get Connected Clients To Web Proxy
GET
Get Infra Nodes Web Proxy
GET
Get Ip Tag
GET
Get Ip Tag Ids
GET
Get Licenses
GET
Get Restore Config
GET
Get Restore Status Report
GET
Get Search Based Alert Config
GET
Get Subnet Mappings
GET
Get Subscriber
GET
Get User
GET
Get User Defined Event
GET
Get User Group
GET
Get User Groups
GET
Get Users
GET
Get Vidm Configuration
GET
Get Web Proxies
GET
Get Web Proxy
GET
List the configured SNMP Trap destination profiles
POST
Migrate event subscriptions To other SNMP Trap destination profiles
POST
Remove Ip Tag
POST
Save Vidm Configuration
POST
Send Test trap To SNMP destination profile
PUT
Update An existing SNMP destination profile
PUT
Update user password
PUT
Update Backup Config
PUT
Update Search Based Alert Config
PUT
Update Subnet Mapping
PUT
Update Subscriber
PUT
Update User Defined Event
PUT
Update Vidm Configuration
PUT
Update Vidm User Group Role
PUT
Update Vidm User Role
PUT
Update Web Proxy
POST
Validate Connections Via Web Proxy
POST
Validate Serial Number
POST
Validate Web Proxy Migration