Add Proxy Configuration

Add Proxy Configuration
Configure HTTP Proxy Settings

Configures HTTP proxy settings for the HCX Manager appliance. The proxy is used for outbound HTTP/HTTPS connections to external services. For non-proxy hosts, wildcards (*.local, *.example.com) are supported.

Request
URI
POST
https://{server}:9443/api/admin/global/config/proxy
COPY
Request Body
ProxyPostRequestBody of type(s) application/json
Required 
{
    "data": {
        "items": [
            {
                "config": {
                    "proxyHost": "string",
                    "proxyPort": "string",
                    "nonProxyHosts": "string",
                    "userName": "string",
                    "password": "string"
                }
            }
        ]
    }
}
object
data
Optional

data

Authentication
This operation uses the following authentication methods.
Responses
200

Proxy configured successfully

Returns ProxyGetResponse200 of type(s) application/json 
{
    "data": {
        "items": [
            {
                "config": {
                    "proxyHost": "string",
                    "proxyPort": "string",
                    "nonProxyHosts": "string",
                    "userName": "string",
                    "UUID": "string"
                },
                "section": "string"
            }
        ]
    }
}
object
data
Required

data


400

Bad request - invalid proxy configuration

Returns ErrorResponse of type(s) application/json 
{
    "isSuccess": false,
    "message": "Request schema validation failed",
    "httpStatusCode": 400
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


500

Internal server error while configuring proxy

Returns ErrorResponse of type(s) application/json 
{
    "isSuccess": false,
    "message": "Request schema validation failed",
    "httpStatusCode": 400
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/admin/global/config/proxy
On This Page
Proxy Configuration Operations
GET
Get Proxy Configuration
POST
Add Proxy Configuration
DELETE
Delete Proxy Configuration