Data Center Gateways

Describe a Data Center Gateway

get/datacentergateways/{dataCenterGatewayID}

Describe a data center gateway by ID.

Related SDK Methods:
Java

DataCenterGatewaysApi.describeDataCenterGateway([param1, param2, ...])
Python

DataCenterGatewaysApi.describe_data_center_gateway([param1, param2, ...])
JavaScript

DataCenterGatewaysApi.describeDataCenterGateway([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
path Parameters
dataCenterGatewayID
required
integer <int32> \d+

The ID number of the data center gateway to describe.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view data center gateways.

404

The data center gateway does not exist.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.DataCenterGatewaysApi;
import com.trendmicro.deepsecurity.model.DataCenterGateway;


public class DescribeDataCenterGatewayExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key");
		Legacy API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key");
		Trend Micro Cloud One API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		DataCenterGatewaysApi instance = new DataCenterGatewaysApi();
		Integer dataCenterGatewayID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			DataCenterGateway result = instance.describeDataCenterGateway(dataCenterGatewayID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling DataCenterGatewaysApi.describeDataCenterGateway");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "name": "string",
  • "publicKey": "string",
  • "gatewayResource": "string",
  • "endpoint": "string",
  • "cloudOneAccountID": "string",
  • "created": 0,
  • "lastModified": 0,
  • "certificate": "string",
  • "privateKey": "string",
  • "rootCA": "string",
  • "ID": 0
}

Modify a Data Center Gateway

post/datacentergateways/{dataCenterGatewayID}

Modify a data center gateway by ID.

Related SDK Methods:
Java

DataCenterGatewaysApi.modifyDataCenterGateway([param1, param2, ...])
Python

DataCenterGatewaysApi.modify_data_center_gateway([param1, param2, ...])
JavaScript

DataCenterGatewaysApi.modifyDataCenterGateway([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
path Parameters
dataCenterGatewayID
required
integer <int32> \d+

The ID number of the data center gateway to describe.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The name of the data center gateway to modify.

name
string

Data center gateway's display name.

Responses
200

successful operation

403

Not authorized to view data center gateways.

404

The data center gateway does not exist.

Request samples
application/json
{
  • "name": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "publicKey": "string",
  • "gatewayResource": "string",
  • "endpoint": "string",
  • "cloudOneAccountID": "string",
  • "created": 0,
  • "lastModified": 0,
  • "certificate": "string",
  • "privateKey": "string",
  • "rootCA": "string",
  • "ID": 0
}

Delete a Data Center Gateway

delete/datacentergateways/{dataCenterGatewayID}

Delete a data center gateway by ID.

Related SDK Methods:
Java

DataCenterGatewaysApi.deleteDataCenterGateway([param1, param2, ...])
Python

DataCenterGatewaysApi.delete_data_center_gateway([param1, param2, ...])
JavaScript

DataCenterGatewaysApi.deleteDataCenterGateway([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
path Parameters
dataCenterGatewayID
required
integer <int32> \d+

The ID number of the data center gateway to describe.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
204

No Content

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.DataCenterGatewaysApi;


public class DeleteDataCenterGatewayExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key");
		Legacy API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key");
		Trend Micro Cloud One API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		DataCenterGatewaysApi instance = new DataCenterGatewaysApi();
		Integer dataCenterGatewayID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			instance.deleteDataCenterGateway(dataCenterGatewayID, apiVersion);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling DataCenterGatewaysApi.deleteDataCenterGateway");
			e.printStackTrace();
		}
	}
}

List Data Center Gateways

get/datacentergateways

List all data center gateways.

Related SDK Methods:
Java

DataCenterGatewaysApi.listDataCenterGateways([param1, param2, ...])
Python

DataCenterGatewaysApi.list_data_center_gateways([param1, param2, ...])
JavaScript

DataCenterGatewaysApi.listDataCenterGateways([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

400

Invalid query parameters.

403

Not authorized to view data center gateways.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.DataCenterGatewaysApi;
import com.trendmicro.deepsecurity.model.DataCenterGateways;


public class ListDataCenterGatewaysExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key");
		Legacy API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key");
		Trend Micro Cloud One API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		DataCenterGatewaysApi instance = new DataCenterGatewaysApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			DataCenterGateways result = instance.listDataCenterGateways(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling DataCenterGatewaysApi.listDataCenterGateways");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "dataCenterGateways": [
    ]
}

Create a Data Center Gateway

post/datacentergateways

Create a new data center gateway.

Related SDK Methods:
Java

DataCenterGatewaysApi.createDataCenterGateway([param1, param2, ...])
Python

DataCenterGatewaysApi.create_data_center_gateway([param1, param2, ...])
JavaScript

DataCenterGatewaysApi.createDataCenterGateway([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The name of the data center gateway to create.

name
string

Data center gateway's display name.

Responses
201

Created

403

Not authorized to add data center gateways.

Request samples
application/json
{
  • "name": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "publicKey": "string",
  • "gatewayResource": "string",
  • "endpoint": "string",
  • "cloudOneAccountID": "string",
  • "created": 0,
  • "lastModified": 0,
  • "certificate": "string",
  • "privateKey": "string",
  • "rootCA": "string",
  • "ID": 0
}

Search Data Center Gateways

post/datacentergateways/search

Search for data center gateways using optional filters.

Related SDK Methods:
Java

DataCenterGatewaysApi.searchDataCenterGateways([param1, param2, ...])
Python

DataCenterGatewaysApi.search_data_center_gateways([param1, param2, ...])
JavaScript

DataCenterGatewaysApi.searchDataCenterGateways([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

A collection of options used to filter the search results.

maxItems
integer <int32>

Limits the number of objects returned. Default 5000.

Array of objects (searchCriteria)

Array of search critiera used to filter objects. Searching with multiple criteria returns results that satisfy all of the criteria. Searching with no criteria returns all objects.

sortByObjectID
boolean

If true, forces the response objects to be sorted by ID, overriding the default sort order. Default "false".

Responses
200

successful operation

403

Not authorized to view data center gateways.

Request samples
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "dataCenterGateways": [
    ]
}
➔ Next to Event Based Tasks