Configure a Proxy Server

Allows configuration of a proxy server. It accepts configuration data specified in the request body in JSON format. If you do not know the proxy settings in your organization, contact your local network administrator. For more information see Define a proxy server.

Resource name: /api/v1/config/proxy

Request Method: POST

Request parameters

Parameter Type Description
useProxy boolean Specifies if a proxy server is used to access the Internet. Default is false.
proxyHost string The proxy server's IP address. Required when useProxy=true.
proxyPort integer The port number used by the proxy server. Required when useProxy=true.
proxyAuth boolean

Specifies if the proxy server requires authentication.

  • true: proxy server requires authentication

  • false: proxy server does not requires authentication
proxyUser string The username for proxy server authentication. Required when proxyAuth=true.
proxyPassword string The password for proxy server authentication. Required when proxyAuth=true.

Request example 

				{
Copy 
{
  "useProxy": true,
  "proxyHost": "proxy.example.com",
  "proxyPort": 8080,
  "proxyAuth": true,
  "proxyUser": "admin",
  "proxyPassword": "password"
}

cUrl Example

Copy 
curl -X POST "https://localhost/api/v1/config/proxy" \
     -H "Content-Type: application/json" \
     -d '{
          "useProxy": true,
          "proxyHost": "proxy.example.com",
          "proxyPort": 8080,
          "proxyAuth": true,
          "proxyUser": "admin",
          "proxyPassword": "password"
     }'

Status codes

Code Description
204 No Content. The configuration was successfully applied.
400 Bad Request. The request data is invalid.
401 Unauthorized. Authentication is required.
403 Forbidden. Insufficient permissions to perform the operation.
404 Not Found. The specified resource could not be located.
423 Locked. The resource is temporarily locked.
429 Too Many Requests. Rate limit exceeded.
500 Internal Server Error. A server-side error occurred.
503 Service Unavailable. The service is temporarily unavailable.

Response parameters

This endpoint does not return any content in the response body for a successful request.

Response example success 204 

(no content)

Response example failure 400

Copy 
{
  "error": "Invalid input data",
  "description": "string",
  "fieldErrors": [
    {
      "field": "proxyPort",
      "error": "Proxy port must be a number"
    }
  ]
}