GCP Connectors

List GCP Connectors

get/gcpconnectors

List all GCP connectors.

Related SDK Methods:
Java

GcpConnectorsApi.listGCPConnectors([param1, param2, ...])
Python

GCPConnectorsApi.list_gcp_connectors([param1, param2, ...])
JavaScript

GCPConnectorsApi.listGCPConnectors([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

403

Not authorized to view GCP connectors.

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.GcpConnectorsApi;
import com.trendmicro.deepsecurity.model.GCPConnectors;


public class ListGCPConnectorsExample {
	
	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
		GcpConnectorsApi instance = new GcpConnectorsApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			GCPConnectors result = instance.listGCPConnectors(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling GcpConnectorsApi.listGCPConnectors");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "gcpconnectors": [
    ]
}

Create a GCP Connector

post/gcpconnectors

Create a new GCP Connector.

Related SDK Methods:
Java

GcpConnectorsApi.createGCPConnector([param1, param2, ...])
Python

GCPConnectorsApi.create_gcp_connector([param1, param2, ...])
JavaScript

GCPConnectorsApi.createGCPConnector([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 settings of the new GCP connector.

name
string

Display name of the connector. Searchable as String.

serviceAccount
string

Service account of the connector, base64-encoded.

Responses
200

successful operation

403

Not authorized to create GCP Connector.

Request samples
application/json
{
  • "name": "string",
  • "serviceAccount": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "serviceAccount": "string",
  • "ownerProjectID": "string",
  • "privateKeyID": "string",
  • "clientEmail": "string",
  • "ID": 0
}

Search GCP Connectors

post/gcpconnectors/search

Search for GCP connectors using optional filters.

Related SDK Methods:
Java

GcpConnectorsApi.searchGCPConnectors([param1, param2, ...])
Python

GCPConnectorsApi.search_gcp_connectors([param1, param2, ...])
JavaScript

GCPConnectorsApi.searchGCPConnectors([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 GCP connectors.

Request samples
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "gcpconnectors": [
    ]
}

Describe a GCP Connector

get/gcpconnectors/{gcpConnectorID}

Describe a GCP connector by ID.

Related SDK Methods:
Java

GcpConnectorsApi.describeGCPConnector([param1, param2, ...])
Python

GCPConnectorsApi.describe_gcp_connector([param1, param2, ...])
JavaScript

GCPConnectorsApi.describeGCPConnector([param1, param2, ...])

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

ID number of the GCP connector 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 GCP connectors.

404

The GCP connector 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.GcpConnectorsApi;
import com.trendmicro.deepsecurity.model.GCPConnector;


public class DescribeGCPConnectorExample {
	
	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
		GcpConnectorsApi instance = new GcpConnectorsApi();
		Integer gcpConnectorID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			GCPConnector result = instance.describeGCPConnector(gcpConnectorID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling GcpConnectorsApi.describeGCPConnector");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "name": "string",
  • "serviceAccount": "string",
  • "ownerProjectID": "string",
  • "privateKeyID": "string",
  • "clientEmail": "string",
  • "ID": 0
}

Modify a GCP Connector

post/gcpconnectors/{gcpConnectorID}

Modify a GCP connector by ID.

Related SDK Methods:
Java

GcpConnectorsApi.modifyGCPConnector([param1, param2, ...])
Python

GCPConnectorsApi.modify_gcp_connector([param1, param2, ...])
JavaScript

GCPConnectorsApi.modifyGCPConnector([param1, param2, ...])

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

ID number of the GCP Connector to modify.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The settings of the GCP connector to modify.

name
string

Display name of the connector. Searchable as String.

serviceAccount
string

Service account of the connector, base64-encoded.

Responses
200

successful operation

403

Not authorized to modify the GCP Connector or the requested modification is not permitted.

404

The GCP Connector does not exist.

Request samples
application/json
{
  • "name": "string",
  • "serviceAccount": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "serviceAccount": "string",
  • "ownerProjectID": "string",
  • "privateKeyID": "string",
  • "clientEmail": "string",
  • "ID": 0
}

Delete a GCP Connector

delete/gcpconnectors/{gcpConnectorID}

Delete a GCP connector by ID.

Related SDK Methods:
Java

GcpConnectorsApi.deleteGCPConnector([param1, param2, ...])
Python

GCPConnectorsApi.delete_gcp_connector([param1, param2, ...])
JavaScript

GCPConnectorsApi.deleteGCPConnector([param1, param2, ...])

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

ID number of the GCP Connector to be deleted.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

Request is successful.

403

Not authorized to delete the GCP connector or the requested modification is not permitted.

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.GcpConnectorsApi;


public class DeleteGCPConnectorExample {
	
	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
		GcpConnectorsApi instance = new GcpConnectorsApi();
		Integer gcpConnectorID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			instance.deleteGCPConnector(gcpConnectorID, apiVersion);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling GcpConnectorsApi.deleteGCPConnector");
			e.printStackTrace();
		}
	}
}
➔ Next to Smart Folders