Get Web Proxy | VMware Aria Operations for Networks API

Get Web Proxy

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

Request

URI

GET

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

COPY

Path Parameters

string

Required

The Entity ID of object requestion information on

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

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": false,
    "user_name": "admin",
    "is_modifiable": 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