• Home
  • Dynatrace Managed
  • Cluster API
  • Cluster API v1
  • Internet proxy v1
  • Set or update cluster proxy configuration

Set or update cluster proxy configuration

This API call updates a cluster proxy configuration.

Authentication

To execute this request, you need the Service Provider API (ServiceProviderAPI) permission assigned to your API token. Generate your API token via Cluster Management Console (CMC). To learn how to obtain and use it, see Cluster API - Authentication.

Endpoint

/api/v1.0/onpremise/proxy/configuration

Parameter

ParameterTypeDescriptionInRequired
bodyInternetProxyChangeRequest

Configuration of proxy server for Internet connection

bodyrequired

Request body objects

The InternetProxyChangeRequest object

Configuration of proxy server for Internet connection

ElementTypeDescriptionRequired
schemestring

Protocol which proxy server uses

The element can hold these values
  • http
  • https
required
serverstring

Address (either IP or Hostname) of proxy server

required
portinteger

Port of proxy server

required
userstring

User of proxy server, null means do not change previous value

optional
passwordstring

Password of proxy server, null means do not change previous value

optional
nonProxyHostsstring[]

Definition of hosts for which proxy won't be used. You can define multiple hosts. Each host can start or end with wildcard '*' for instance to match whole domain.

optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

json
{ "scheme": "http", "server": "string", "port": 1, "user": "string", "password": "string", "nonProxyHosts": [ "string" ] }

Response

Response codes

CodeDescription
201

Successful, new configuration created

204

Successful, configuration updated

400

Given proxy configuration is invalid

Example

In this example, you add a proxy server (outbound-proxy.dynatrace.com) that uses port 8080 and requires a password, at the same time excluding an internal lab host (*.internal.lab.company.com).

Curl

bash
curl -X PUT "https://myManaged.cluster.com/api/v1.0/onpremise/proxy/configuration" -H "accept: */*" -H "Content-Type: application/json" -d "{\"scheme\":\"http\",\"server\":\"outbound-proxy.dynatrace.com\",\"port\":8080,\"nonProxyHosts\":[\"https://mycompany.com/proxy/*\",\"*.internal.lab.company.com\"],\"userOrPasswordDefined\":true}"

Request URL

plaintext
https://myManaged.cluster.com/api/v1.0/onpremise/proxy/configuration

Response body

json
{ "code": 201, "message": "Successful, new configuration created." }

Response code

201