Update Proxy Configuration

Update Proxy Configuration

Update Proxy configuration

Request
URI
PATCH
https://{api_host}/v1/system/proxy-configuration
COPY
Request Body
ProxyConfiguration of type(s) application/json
Required 
{
    "isConfigured": false,
    "isEnabled": false,
    "host": "10.0.0.250",
    "port": 3128,
    "transferProtocol": "string",
    "username": "string",
    "password": "string",
    "isAuthenticated": false
}
boolean
isConfigured
Optional

Is proxy configured

boolean
isEnabled
Optional

Is proxy enabled

string
host
Optional

IP address/FQDN of proxy server

integer As int32 As int32
port
Optional

Port of proxy server

string
transferProtocol
Optional

Proxy transfer protocol, default value is HTTP

Possible values are : HTTP, HTTPS,
string
username
Optional

User name to connect

string
password
Optional

User password to connect, will return null on reading

boolean
isAuthenticated
Optional

Is proxy authenticated

Responses
202

Accepted

Returns Task of type(s) application/json 
"Task Object"
string
id
Required

Task ID

string
name
Required

Task name

object
localizableDescriptionPack
Optional

A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.

string
type
Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _

string
status
Required

Task status

string
creationTimestamp
Required

Task creation timestamp

string
completionTimestamp
Optional

Task completion timestamp

array of object
subTasks
Optional

List of sub-tasks of the task

array of object
errors
Optional

List of errors in case of a failure

array of object
resources
Optional

List of resources associated with task

string
resolutionStatus
Optional

Resolution state

boolean
isCancellable
Optional

Represents task can be cancellable or not.

boolean
isRetryable
Optional

Indicates whether a task is eligible for retry or not.


400

Bad request

Returns Error of type(s) application/json 
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

Internal server error

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Proxy Configuration Operations
GET
Get Proxy Configuration
PATCH
Update Proxy Configuration