Get Proxy Configuration

Get Proxy Configuration
Get HTTP Proxy Configuration

Retrieves the configured HTTP proxy settings for the HCX Manager. HTTP proxy is used by HCX Manager to access external services and internet resources.

Returns:

  • Proxy Host: Hostname or IP address of proxy server
  • Proxy Port: Port number for proxy connection
  • Non-Proxy Hosts: Comma-separated list of hosts to bypass proxy
  • Username: Authentication username (if proxy requires auth)
Request
URI
GET
https://{server}:9443/api/admin/global/config/proxy
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Proxy configuration retrieved 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


500

Internal server error while retrieving 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


Code Samples
COPY
                    curl -H 'Authorization: <value>' 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