HA - Get proxy configuration for specific data center

  • Published Nov 18, 2020

This API call retrieves a proxy configuration for a specific data center in premium high availability deployments.

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/configurations

Parameter

ParameterTypeDescriptionInRequired
dcstring

Data Center

pathrequired

Response

Response codes

CodeTypeDescription
200InternetProxy

Success

404-

Proxy is not configured for given Data Center

Response body objects

The InternetProxy object

Configuration of proxy server for Internet connection

ElementTypeDescription
nonProxyHostsstring[]

Definition of hosts for which proxy won't be used.

portinteger

Port of proxy server

schemestring

Protocol which proxy server uses

serverstring

Address (either IP or Hostname) of proxy server

userOrPasswordDefinedboolean

Indicates if user/password for proxy is configured

Response body JSON model

{
"nonProxyHosts": [
"string"
],
"port": 1,
"scheme": "string",
"server": "string",
"userOrPasswordDefined": true
}

Example

In this example, you request to receive proxy configurations for a specific data center (eu-west-1). In return you receive JSON response listing of proxy configurations only for eu-west-1.

Curl

curl -X GET "https://myManaged.cluster.com/api/v1.0/onpremise/proxy/configurations/eu-west-1" -H "accept: application/json"

Request URL

https://myManaged.cluster.com/api/v1.0/onpremise/proxy/configurations/eu-west-1

Response body

{
"scheme": "http",
"server": "outbound-proxy-dc1.dynatrace.com",
"port": 8080,
"nonProxyHosts": [
"https://mycompany.com/proxy/*",
"*.internal.lab.company.com"
],
"userOrPasswordDefined": true
}

Response code

200