Add HTTP Proxy on Server Group

Select

SaaS

Customer Managed

Configure HTTP proxy on server group level.

application/json

Request Body

• entity object

  clientGroupId integer

  Id of the server group

• httpProxy object

  server string

  HTTP server hostname/IP

  port integer

  Port number for the HTTP proxy

  useForNetworkRoutes boolean

  if set as true, Commvault connections will be honouring the proxy along with the routes

  proxyBypassList string

  Domains/hostnames/IPs that bypass the proxy

  configureHTTPProxy boolean

  Set HTTP proxy is active

  useAuthentication boolean

  Set as true, if authentication is required.

  credentials object

  Credential used for authentication

  credentialId integer

  credentialName string

  proxyType string

  Possible values: [EXPLICIT, GLOBAL, NONE]

  Type of proxy. EXPLICIT: User explicitly specified proxy, GLOBAL: Proxy is auto-detected, NONE: No proxy

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Response

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• errorCode integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "errorCode": 0
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "errorCode": 0
}

POST /httpproxysettings    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• proxy without providing credentials
• proxy with credentials and bypass list
• use client os proxy setting
• remove http proxy from a server group

---

{
  "entity": {
    "clientGroupId": 0
  },
  "httpProxy": {
    "server": "string",
    "port": 0,
    "useForNetworkRoutes": true,
    "proxyBypassList": "string",
    "configureHTTPProxy": true,
    "useAuthentication": true,
    "credentials": {
      "credentialId": 0,
      "credentialName": "string"
    },
    "proxyType": "EXPLICIT"
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/HttpProxySettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entity": {
    "clientGroupId": 0
  },
  "httpProxy": {
    "server": "string",
    "port": 0,
    "useForNetworkRoutes": true,
    "proxyBypassList": "string",
    "configureHTTPProxy": true,
    "useAuthentication": true,
    "credentials": {
      "credentialId": 0,
      "credentialName": "string"
    },
    "proxyType": "EXPLICIT"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/HttpProxySettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entity": {
    "clientGroupId": 0
  },
  "httpProxy": {
    "server": "string",
    "port": 0,
    "useForNetworkRoutes": true,
    "proxyBypassList": "string",
    "configureHTTPProxy": true,
    "useAuthentication": true,
    "credentials": {
      "credentialId": 0,
      "credentialName": "string"
    },
    "proxyType": "EXPLICIT"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/HttpProxySettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entity": {
    "clientGroupId": 0
  },
  "httpProxy": {
    "server": "string",
    "port": 0,
    "useForNetworkRoutes": true,
    "proxyBypassList": "string",
    "configureHTTPProxy": true,
    "useAuthentication": true,
    "credentials": {
      "credentialId": 0,
      "credentialName": "string"
    },
    "proxyType": "EXPLICIT"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/HttpProxySettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entity": {
    "clientGroupId": 0
  },
  "httpProxy": {
    "server": "string",
    "port": 0,
    "useForNetworkRoutes": true,
    "proxyBypassList": "string",
    "configureHTTPProxy": true,
    "useAuthentication": true,
    "credentials": {
      "credentialId": 0,
      "credentialName": "string"
    },
    "proxyType": "EXPLICIT"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/HttpProxySettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entity": {
    "clientGroupId": 0
  },
  "httpProxy": {
    "server": "string",
    "port": 0,
    "useForNetworkRoutes": true,
    "proxyBypassList": "string",
    "configureHTTPProxy": true,
    "useAuthentication": true,
    "credentials": {
      "credentialId": 0,
      "credentialName": "string"
    },
    "proxyType": "EXPLICIT"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/HttpProxySettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entity": {
    "clientGroupId": 0
  },
  "httpProxy": {
    "server": "string",
    "port": 0,
    "useForNetworkRoutes": true,
    "proxyBypassList": "string",
    "configureHTTPProxy": true,
    "useAuthentication": true,
    "credentials": {
      "credentialId": 0,
      "credentialName": "string"
    },
    "proxyType": "EXPLICIT"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/HttpProxySettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entity": {
    "clientGroupId": 0
  },
  "httpProxy": {
    "server": "string",
    "port": 0,
    "useForNetworkRoutes": true,
    "proxyBypassList": "string",
    "configureHTTPProxy": true,
    "useAuthentication": true,
    "credentials": {
      "credentialId": 0,
      "credentialName": "string"
    },
    "proxyType": "EXPLICIT"
  }
}'