Validate Connections Via Web Proxy

Validate the connections with the updated web proxy settings. Only admin users can perform this action.

Request

URI

POST

https://www.mgmt.cloud.vmware.com/ni/api/ni/settings/proxy-servers/{id}/validate-entities

COPY

Path Parameters

string

Required

The Entity ID of object requestion information on

Request Body

Web Proxy Details to be updated

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

200

Success

Returns ValidateConnectionViaWebProxyResponseList of type(s) application/json

{
    "results": [
        {
            "entity_id": "10000:1:15332641552",
            "entity_type": "DataSource",
            "name": "vcenter",
            "identifier": "10.98.101.59",
            "status": "PASS",
            "error_code": -1,
            "message": "string"
        }
    ]
}

array of ValidateConnectionViaWebProxyResponse

results

Optional

results

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