keyboard_arrow_down
  • 12.0
  • 20.0

Contacts

Describe a Contact

get/contacts/{contactID}

Describe a contact by ID.

Related SDK Methods:
Java

ContactsApi.describeContact([param1, param2, ...])
Python

ContactsApi.describe_contact([param1, param2, ...])
JavaScript

ContactsApi.describeContact([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
contactID
required
integer <int32> \d+

The ID number of the contact 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 contacts.

404

The contact 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.ApiException;
import com.trendmicro.deepsecurity.api.ContactsApi;
import com.trendmicro.deepsecurity.model.Contact;


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

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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
		ContactsApi instance = new ContactsApi();
		Integer contactID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			Contact result = instance.describeContact(contactID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ContactsApi.describeContact");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "phoneNumber": "string",
  • "mobileNumber": "string",
  • "pagerNumber": "string",
  • "emailAddress": "string",
  • "locale": "en-US",
  • "roleID": 0,
  • "reportPDFPasswordEnabled": true,
  • "reportPDFPassword": "string",
  • "ID": 0
}

Modify a Contact

post/contacts/{contactID}

Modify a contact by ID. Any unset elements will be left unchanged.

Related SDK Methods:
Java

ContactsApi.modifyContact([param1, param2, ...])
Python

ContactsApi.modify_contact([param1, param2, ...])
JavaScript

ContactsApi.modifyContact([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
contactID
required
integer <int32> \d+

The ID number of the contact 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 contact to modify.

description
string

Description of the Contact. Searchable as String.

emailAddress
string

Email address of the Contact. Searchable as String.

locale
string

Locale of the Contact.

Enum: "en-US" "ja-JP"
mobileNumber
string

Mobile number of the Contact. Searchable as String.

name
string

Name of the Contact. Searchable as String.

pagerNumber
string

Pager number of the Contact. Searchable as String.

phoneNumber
string

Phone number of the Contact. Searchable as String.

reportPDFPassword
string

Password that protects the reports that the Contact generates. Ignored when reportPDFPasswordEnabled is false.

reportPDFPasswordEnabled
boolean

Controls whether the reports that the Contact generates are password-protected. Set to true to password-protect, and false otherwise. Defaults to false. Searchable as Boolean.

roleID
integer <int32>

ID of the role assigned to the Contact. Searchable as Numeric.

Responses
200

successful operation

403

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

404

The contact does not exist.

Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "phoneNumber": "string",
  • "mobileNumber": "string",
  • "pagerNumber": "string",
  • "emailAddress": "string",
  • "locale": "en-US",
  • "roleID": 0,
  • "reportPDFPasswordEnabled": true,
  • "reportPDFPassword": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "phoneNumber": "string",
  • "mobileNumber": "string",
  • "pagerNumber": "string",
  • "emailAddress": "string",
  • "locale": "en-US",
  • "roleID": 0,
  • "reportPDFPasswordEnabled": true,
  • "reportPDFPassword": "string",
  • "ID": 0
}

Delete a Contact

delete/contacts/{contactID}

Delete a contact by ID.

Related SDK Methods:
Java

ContactsApi.deleteContact([param1, param2, ...])
Python

ContactsApi.delete_contact([param1, param2, ...])
JavaScript

ContactsApi.deleteContact([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
contactID
required
integer <int32> \d+

The ID number of the contact to delete.

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 contacts.

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


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

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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
		ContactsApi instance = new ContactsApi();
		Integer contactID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			instance.deleteContact(contactID, apiVersion);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ContactsApi.deleteContact");
			e.printStackTrace();
		}
	}
}

List Contacts

get/contacts

Lists all contacts.

Related SDK Methods:
Java

ContactsApi.listContacts([param1, param2, ...])
Python

ContactsApi.list_contacts([param1, param2, ...])
JavaScript

ContactsApi.listContacts([param1, param2, ...])

Request
Security:
DefaultAuthentication
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 contacts.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.ContactsApi;
import com.trendmicro.deepsecurity.model.Contacts;


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

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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
		ContactsApi instance = new ContactsApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			Contacts result = instance.listContacts(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling ContactsApi.listContacts");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "contacts": [
    ]
}

Create a Contact

post/contacts

Create a new contact.

Related SDK Methods:
Java

ContactsApi.createContact([param1, param2, ...])
Python

ContactsApi.create_contact([param1, param2, ...])
JavaScript

ContactsApi.createContact([param1, param2, ...])

Request
Security:
DefaultAuthentication
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 contact to modify.

description
string

Description of the Contact. Searchable as String.

emailAddress
string

Email address of the Contact. Searchable as String.

locale
string

Locale of the Contact.

Enum: "en-US" "ja-JP"
mobileNumber
string

Mobile number of the Contact. Searchable as String.

name
string

Name of the Contact. Searchable as String.

pagerNumber
string

Pager number of the Contact. Searchable as String.

phoneNumber
string

Phone number of the Contact. Searchable as String.

reportPDFPassword
string

Password that protects the reports that the Contact generates. Ignored when reportPDFPasswordEnabled is false.

reportPDFPasswordEnabled
boolean

Controls whether the reports that the Contact generates are password-protected. Set to true to password-protect, and false otherwise. Defaults to false. Searchable as Boolean.

roleID
integer <int32>

ID of the role assigned to the Contact. Searchable as Numeric.

Responses
200

successful operation

403

Not authorized to create contacts.

Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "phoneNumber": "string",
  • "mobileNumber": "string",
  • "pagerNumber": "string",
  • "emailAddress": "string",
  • "locale": "en-US",
  • "roleID": 0,
  • "reportPDFPasswordEnabled": true,
  • "reportPDFPassword": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "phoneNumber": "string",
  • "mobileNumber": "string",
  • "pagerNumber": "string",
  • "emailAddress": "string",
  • "locale": "en-US",
  • "roleID": 0,
  • "reportPDFPasswordEnabled": true,
  • "reportPDFPassword": "string",
  • "ID": 0
}

Search Contacts

post/contacts/search

Search for contacts using optional filters.

Related SDK Methods:
Java

ContactsApi.searchContacts([param1, param2, ...])
Python

ContactsApi.search_contacts([param1, param2, ...])
JavaScript

ContactsApi.searchContacts([param1, param2, ...])

Request
Security:
DefaultAuthentication
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 contacts.

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