Get Proxy Configuration
Get the current Proxy configuration
Request
URI
GET
https://{api_host}/v1/system/proxy-configuration
COPY
Responses
200
OK
Returns ProxyConfiguration of type(s) application/json
{
"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
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.
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 -H 'Authorization: <value>' https://{api_host}/v1/system/proxy-configuration