Test cluster proxy configuration
This API call tests 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/test
Parameter
Parameter | Type | Description | In | Required |
---|---|---|---|---|
body | Internet | Configuration of proxy server for Internet connection | body | required |
Request body objects
The InternetProxyChangeRequest
object
Configuration of proxy server for Internet connection
Element | Type | Description | Required |
---|---|---|---|
nonProxyHosts | string[] | 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 |
password | string | Password of proxy server, null means do not change previous value | optional |
port | integer | Port of proxy server | required |
scheme | string | Protocol which proxy server uses | required |
server | string | Address (either IP or Hostname) of proxy server | required |
user | string | User of proxy server, null means do not change previous value | 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.
{
"nonProxyHosts": [
"string"
],
"password": "string",
"port": 1,
"scheme": "http",
"server": "string",
"user": "string"
}
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Connection | Request was processed, check response body for details |
Response body objects
The ConnectionStatus
object
Internet connection test result
Element | Type | Description |
---|---|---|
connectionOk | boolean | Connection test result |
testExecuted | boolean | Indicates whether test was executed at all |
testExecutionMessage | string | Additional comments usually indicates why test was not executed |
Response body JSON model
{
"connectionOk": true,
"testExecuted": true,
"testExecutionMessage": "string"
}
Example
In this example, you test 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
). In return you receive a JSON response indicating that the connection is OK.
Curl
curl -X PUT "https://myManaged.cluster.com/api/v1.0/onpremise/proxy/test" -H "accept: application/json" -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
https://myManaged.cluster.com/api/v1.0/onpremise/proxy/test
Response body
{
"connectionOk": true,
"testExecuted": true,
"testExecutionMessage": "string"
}
Response code
200