Describe a Proxy
Describe a proxy by ID.
ProxiesApi.describeProxy([param1, param2, ...])
ProxiesApi.describe_proxy([param1, param2, ...])
ProxiesApi.describeProxy([param1, param2, ...])
successful operation
The proxy type is not supported.
Not authorized to view proxies.
The proxy does not exist.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.ProxiesApi; import com.trendmicro.deepsecurity.model.Proxy; public class DescribeProxyExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Initialization // Set Any Required Values ProxiesApi instance = new ProxiesApi(); Integer proxyID = 1; String proxyType = "proxyType_example"; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours Proxy result = instance.describeProxy(proxyID, proxyType, apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling ProxiesApi.describeProxy"); e.printStackTrace(); } } }
- 200
{- "name": "string",
- "description": "string",
- "hostName": "string",
- "port": 0,
- "protocol": "http",
- "authenticated": true,
- "username": "string",
- "password": "string",
- "proxyType": "string",
- "sgproxy": true,
- "ID": 0,
- "ips": "string"
}
Modify a Proxy
Modify a proxy by ID. Any unset elements will be left unchanged.
ProxiesApi.modifyProxy([param1, param2, ...])
ProxiesApi.modify_proxy([param1, param2, ...])
ProxiesApi.modifyProxy([param1, param2, ...])
header Parameters
Request Body schema: application/json
The settings of the proxy to modify.
successful operation
Not authorized to modify proxies or the requested modification is not permitted.
The proxy does not exist.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string",
- "hostName": "string",
- "port": 0,
- "protocol": "http",
- "authenticated": true,
- "username": "string",
- "password": "string",
- "proxyType": "string",
- "sgproxy": true,
- "ips": "string"
}
- 200
{- "name": "string",
- "description": "string",
- "hostName": "string",
- "port": 0,
- "protocol": "http",
- "authenticated": true,
- "username": "string",
- "password": "string",
- "proxyType": "string",
- "sgproxy": true,
- "ID": 0,
- "ips": "string"
}
Delete a Proxy
Delete a proxy by ID.
ProxiesApi.deleteProxy([param1, param2, ...])
ProxiesApi.delete_proxy([param1, param2, ...])
ProxiesApi.deleteProxy([param1, param2, ...])
Request is successful.
Not authorized to delete proxies.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.ProxiesApi; public class DeleteProxyExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Initialization // Set Any Required Values ProxiesApi instance = new ProxiesApi(); Integer proxyID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours instance.deleteProxy(proxyID, apiVersion); } catch (ApiException e) { System.err.println("An exception occurred when calling ProxiesApi.deleteProxy"); e.printStackTrace(); } } }
List Proxies
Lists all proxies.
ProxiesApi.listProxies([param1, param2, ...])
ProxiesApi.list_proxies([param1, param2, ...])
ProxiesApi.listProxies([param1, param2, ...])
successful operation
Not authorized to view proxies.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.ProxiesApi; import com.trendmicro.deepsecurity.model.Proxies; public class ListProxiesExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Initialization // Set Any Required Values ProxiesApi instance = new ProxiesApi(); Boolean includesSG = true; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours Proxies result = instance.listProxies(includesSG, apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling ProxiesApi.listProxies"); e.printStackTrace(); } } }
- 200
{- "proxies": [
- {
- "name": "string",
- "description": "string",
- "hostName": "string",
- "port": 0,
- "protocol": "http",
- "authenticated": true,
- "username": "string",
- "password": "string",
- "proxyType": "string",
- "sgproxy": true,
- "ID": 0,
- "ips": "string"
}
]
}
Create a Proxy
Create a new proxy.
ProxiesApi.createProxy([param1, param2, ...])
ProxiesApi.create_proxy([param1, param2, ...])
ProxiesApi.createProxy([param1, param2, ...])
header Parameters
Request Body schema: application/json
The settings of the proxy to modify.
successful operation
Not authorized to create proxies.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string",
- "hostName": "string",
- "port": 0,
- "protocol": "http",
- "authenticated": true,
- "username": "string",
- "password": "string",
- "proxyType": "string",
- "sgproxy": true,
- "ips": "string"
}
- 200
{- "name": "string",
- "description": "string",
- "hostName": "string",
- "port": 0,
- "protocol": "http",
- "authenticated": true,
- "username": "string",
- "password": "string",
- "proxyType": "string",
- "sgproxy": true,
- "ID": 0,
- "ips": "string"
}
Search Proxies
Search for proxies using optional filters.
ProxiesApi.searchProxies([param1, param2, ...])
ProxiesApi.search_proxies([param1, param2, ...])
ProxiesApi.searchProxies([param1, param2, ...])
header Parameters
Request Body schema: application/json
A collection of options used to filter the search results.
successful operation
Not authorized to view proxies.
- Payload
- Java
- Python
- JavaScript
{- "maxItems": 0,
- "searchCriteria": [
- {
- "fieldName": "string",
- "booleanTest": true,
- "numericTest": "less-than",
- "numericValue": 0,
- "numericValueList": [
- 0
], - "stringTest": "equal",
- "stringValue": "string",
- "stringWildcards": true,
- "choiceTest": "equal",
- "choiceValue": "string",
- "firstDateValue": 0,
- "firstDateInclusive": true,
- "lastDateValue": 0,
- "lastDateInclusive": true,
- "nullTest": true,
- "versionTest": "less-than",
- "versionValue": "string",
- "idValue": 0,
- "idTest": "less-than",
- "idValueList": [
- 0
]
}
], - "sortByObjectID": true
}
- 200
{- "proxies": [
- {
- "name": "string",
- "description": "string",
- "hostName": "string",
- "port": 0,
- "protocol": "http",
- "authenticated": true,
- "username": "string",
- "password": "string",
- "proxyType": "string",
- "sgproxy": true,
- "ID": 0,
- "ips": "string"
}
]
}