Update Proxy Settings

Update Proxy Settings

Update the current proxy's configuration. This is part of the initialization wizard. Upon successful test_proxy with accessToken and proxy details, invoke this endpoint to save the proxy settings. In case no proxy is involved (direct connection to cloud) invoking this method is not required.

Request
URI
POST
https://umip/api/v1/http_proxy
COPY
Request Body

Updating proxy configuration request body.

TestProxyAndAccessTokenRequest of type(s) application/json
Required

Show optional properties

{
    "type": "string",
    "accessToken": "string"
}
{
    "type": "string",
    "accessToken": "string",
    "host": "string",
    "port": 0,
    "user": "string",
    "password": "string"
}
string
type
Required

Type of the proxy. Select none for direct communication with the cloud.

Possible values are : none, http, https,
string
accessToken
Required

Access Token from the current agent registration process from VCF Business Services console.

string
host
Optional

Proxy's host.

integer
port
Optional

Proxy's port.

string
user
Optional

Proxy's username if authentication is required.

string
password
Optional

Proxy's password if authentication is required.

Authentication
This operation uses the following authentication methods.
Responses
202

In case the proxy's configuration has been successfully saved.

Operation doesn't return any data structure

400

In case there are errors during the proxy configuration update.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"type:"string","accessToken:"string"}' https://{api_host}/api/v1/http_proxy
On This Page
Proxy Configuration Settings Operations
GET
Get Proxy Settings
POST
Update Proxy Settings