Configuring proxies
If your environment includes one or more web proxies, provide the proxy addresses to your Connector Appliance.
The Connector Appliance can communicate with both on-premises systems in your resource location and with external systems. If you define one or more web proxies during Connector Appliance registration, only traffic from the Connector Appliance to external systems is routed through this web proxy. If your on-premises system is located in a private address space, traffic from Connector Appliance to this system is not routed through the web proxy.
Both unauthenticated and authenticated proxies are supported. However, only basic proxy authentication is supported. Other forms of authentication are not supported.
For more information, see the product documentation.
List the configured proxies
Use this call to list all proxies that are configured in your Connector Appliance.
Request
GET /proxies HTTP/1.1
Accept: */*
Host: <connector-appliance-ip-address>
Authorization: Bearer <token>
<!--NeedCopy-->
Response
Success
HTTP/1.1 200 OK
{
"items": [
{
"id": "4bc94059-f386-4411-aa80-ab2da95c8615",
"location": "proxy.example.com:3128",
"status": "reachable"
}
]
}
<!--NeedCopy-->
The status of the proxy can be reachable or unreachable. The value unreachable indicates that the proxy is either incorrect or inaccessible.
Add a proxy
Use this call to add a proxy to the list of proxies configured in your Connector Appliance.
Requests
When specifying your proxy location, you must include the port number.
Unauthenticated proxy
POST /proxies HTTP/1.1
Accept: */*
Authorization: Bearer <token>
Content-Length
Content-Type: application/json
Host: <connector-appliance-ip-address>
Connection: keep-alive
{"location": "<host>:<port>"}
<!--NeedCopy-->
Basic authenticated proxy
POST /proxies HTTP/1.1
Accept: */*
Authorization: Bearer <token>
Content-Length
Content-Type: application/json
Host: <connector-appliance-ip-address>
Connection: keep-alive
{"location": "<host>:<port>", "username": "<username>", "password": "<password>"}
<!--NeedCopy-->
Response
Success
A successful response includes an ID for the proxy that can be used to refer to the proxy in API calls.
HTTP/1.1 200 OK
{
"id": "<proxy-id>",
"location": "<host>:<port>",
"status": "reachable"
}
<!--NeedCopy-->
The status of the proxy can be reachable or unreachable. The value unreachable indicates that the proxy is either incorrect or inaccessible.
Remove a proxy
Use this call to remove a proxy from the list of proxies configured in your Connector Appliance.
Request
To remove a proxy, you must know the ID for the proxy. This value is provided when you add the proxy to the Connector Appliance configuration or you can get it by listing the curerntly configured proxies.
DELETE /proxies/<proxy-id>
Host: <connector-appliance-ip-address>
Authorization: Bearer <token>
<!--NeedCopy-->
Responses
Success
HTTP/1.1 204 No Content
<!--NeedCopy-->
The proxy was successfully deleted.
Proxy not found
HTTP/1.1 404 Not Found
<!--NeedCopy-->
The proxy was not found and, as a result, not deleted. Check that the proxy ID in the URL is correct.