# Deep Security Manager REST API

Elements
Name | Description
--- | ---
Action | The action that will be performed by a task.
ActionRequest | A wrapper object around an Action that can be passed in a REST API call.
addActivationCodeResponse | Response returned after add new Activation Code.
AddAdministratorRoleHostGroupsRequest | Request object for the AddAdministratorRoleHostGroups API.
AddAdministratorRoleHostsRequest | Request object for the AddAdministratorRoleHosts API.
AddAdministratorRolePoliciesRequest | Request object for the AddAdministratorRolePolicies API.
AddAdministratorRoleRightsRequest | Request object for the AddAdministratorRoleRights API.
AddAwsAccountRequest | Request object for the AWS Account API.
AddAwsAccountResponse |
Administrator | Administrator details.
AdministratorRole | Transport object for administrator role details.
antiMalwareEvent |
antiMalwareEventListing | Response object for the ListAntiMalwareEvents API.
antiMalwareScanConfig |
antiMalwareScanConfigListing | Response returned when querying antiMalware scan configurations
antiMalwareSpywareItem |
AppControlPolicyParameters | Details of the application control parameters for a policy.
ApplicationActionRequest | A request to perform a given action on all drift items in a given scope.
ApplicationDetail | Details for an application, identified by a hash value.
applicationInfos | Application information passed to log in to DSM.
AssumeRoleWithSAMLRequest | Request object for the AssumeRoleWithSAML API.
AssumeRoleWithSAMLResponse | Response object for the AssumeRoleWithSAML API.
Attribute |
awsCredentials |
awsRegion |
BackupTaskParameters | Parameters for backup task.
BarDataElement |
barDataListing |
Bucket |
CheckForSecurityUpdatesTaskParameters | Parameters for check for security updates task.
cloudAccount | A Cloud Account object
cloudAccount | A structure containing information about a cloud account.
component | Represents the information for an individual component in the system.
ComponentInfo | Container for the component detail information
componentListing | response returned when querying the component information of a host i.e.
ComputerActionRequest | A request to perform an action on drift items within a given scope, as well as on a specific host ID specified elsewhere.
Condition | A condition that must be true for an event-based task to start.
counter | Base class for all counters
counterApplicationTypeElement | A placeholder to store application type activity for RESTful response
counterApplicationTypeListing | A listing to store CounterApplicationTypeElement
counterIntegrityRuleElement | A placeholder to store integrity rule for RESTful response
counterIntegrityRuleListing | A listing to store CounterIntegrityRuleElement
counterLogInspectionRuleElement | A placeholder to store Log Inspection rules for RESTful response
counterLogInspectionRuleListing | A listing to store CounterLogInspectionRuleElement
counterMalwareDetectedElement | A placeholder to store detected malware for RESTful response
counterMalwareDetectedListing | A listing to store CounterMalwareDetectedElement
counterPacketElement | A placeholder to store firewall activity for RESTful response
counterPacketListing | A listing to store CounterPacketElement
counterPayloadElement | A placeholder to store IPS activity for RESTful response
counterPayloadListing | A listing to store CounterPayloadElement
counterWebReputationUrlListing | A listing to store CounterWebReputationUrlElement
counterWebReputationUrlsElement | A placeholder to store Web Reputation URL Activity for RESTful response Reference to class 'CounterKey'
CreateAdministratorRequest | Request object for the CreateAdministrator API.
CreateAdministratorResponse | Response object for the CreateAdministrator API.
CreateAdministratorRoleRequest | Request object for the CreateAdministratorRole API.
CreateAdministratorRoleResponse | Response object for the CreateAdministratorRole API.
createAntiMalwareScanConfigRequest | Provides options for the creation of a new antiMalware scan configuration.
createAntiMalwareScanConfigResponse | Response returned when creating a new AntiMalware Scan Configuration
createCloudAccountRequest | Provides options for the creation of a new cloud account.
createCloudAccountResponse | Response returned when creating a new cloud account
CreateEventBasedTaskRequest | Request object for the CreateEventBasedTask API.
CreateEventBasedTaskResponse | Response object for the CreateEventBasedTask API.
CreateInventoryRequest | Request object for the CreateInventory API.
CreateInventoryResponse | Response object for the CreateInventory API.
CreateProxyRequest | Request object for the CreateProxy API.
CreateProxyResponse | Response object for the CreateProxy API.
CreateRulesetRequest | Request object for the CreateRuleset API.
CreateRulesetResponse |
CreateSAMLIdentityProviderRequest | Request object for the CreateSAMLIdentityProvider API.
CreateSAMLIdentityProviderResponse | Response object for the CreateSAMLIdentityProvider API.
CreateScheduledTaskRequest | Request object for the CreateScheduledTask API.
CreateScheduledTaskResponse | Response object for the CreateScheduledTask API.
CreateSmartFolderRequest | Request object for the CreateSmartFolder API method.
CreateSmartFolderResponse | Response object that gets returned from the CreateSmartFolder API method.
CreateSSLConfigurationRequest | Request object for the CreateSSLConfiguration API
CreateSSLConfigurationResponse | Response object for the CreateSSLConfiguration API
CreateSyslogConfigurationRequest | Request object for the CreateSyslogConfiguration API.
CreateSyslogConfigurationResponse | Response object for the CreateSyslogConfiguration API.
createTenantDatabaseServerRequest | Class encapsulating data/directive to be used for the creation of a new tenant secondary database server.
createTenantDatabaseServerResponse | Response returned after creating a new tenant database server
createTenantOptions | Attributes used for controlling the creation of a new tenant.
createTenantRequest | Class encapsulating data/directive to be used for the creation of a new tenant.
createTenantResponse | Response returned after creating a tenant.
createTenantTemplateRequest | Provides options for the creation of a new tenant template.
createTenantTemplateResponse | Response returned after creating a tenant template.
crossAccountRole | Cross Account Role object
DailyScheduleParameters | Parameters for daily schedule
DecisionLog | An Application Control Decision Log.
DecisionLogDetail | An Application Control Decision Log Detail.
DecisionLogDetails | Response object for the ListDecisionLogDetails API.
deleteCloudAccountResponse | Response returned when deleting a cloud account
deleteTenantDatabaseServerResponse | Response returned after deleting a tenant database server
deleteTenantResponse | Response returned after deleting a tenant.
DescribeAdministratorResponse | Response object for the DescribeAdministrator API.
DescribeAdministratorRoleResponse | Response object for the DescribeAdministratorRole API.
DescribeApplicationControlPolicyResponse | Response object for the DescribeApplicationControlPolicy API.
DescribeApplicationDriftRequest | Request object for the DescribeApplicationDrift API.
DescribeApplicationDriftResponse | Response object for the DescribeApplicationDrift API.
DescribeApplicationRequest | Request object for the DescribeApplicationRequest API.
DescribeApplicationResponse | Response object for the DescribeApplication API.
DescribeComputerDriftRequest | Request object for the DescribeComputerDrift API.
DescribeComputerDriftResponse | Response object for the DescribeComputerDrift API.
DescribeDecisionLogResponse | Response object for the DescribeDecisionLog API.
DescribeDriftDetailsResponse | Response object for the DescribeDriftDetails API.
DescribeDriftRequest | Request object for the DescribeDrift API.
DescribeDriftResponse | Response object for the DescribeDrift API.
DescribeEventResponse | Response object for the DescribeEvent API.
DescribeEventResponse | Response object for the DescribeEvent API.
DescribeEventResponse | Response object for the DescribeEvent API.
DescribeInventoryResponse | Response object for the DescribeInventory API.
DescribeManagerNodeResponse | Response object for the DescribeManagerNode API.
DescribeNewsFeedResponse | Response object for the News Feed API.
DescribeProxyResponse | Response object for the DescribeProxy API.
DescribeRulesetResponse |
DescribeSAMLIdentityProviderResponse | Response object for the DescribeSAMLIdentityProvider API.
DescribeSAMLServiceProviderResponse | Response object for the DescribeSAMLServiceProvider API.
DescribeScheduledTaskResponse | Response object for the DescribeScheduledTask API.
DescribeSessionResponse | Response object for the DescribeSession API.
DescribeSSLConfigurationResponse | Response object for the DescribeSSLConfiguration API
DescribeSyslogConfigurationResponse | Response object for the DescribeSyslogConfiguration API.
DescribeTrustedUpdateModeResponse | Response object for the DescribeTrustedUpdateMode API.
DiscoverComputersTaskParameters | Parameters for discovery task
Disk | Manager node disk information.
DriftHostGroup | A representation of a host group, including a set of child groups and a drift item count across all hosts and child groups in the group.
DriftItemDetails | A full set of details for one drift item.
DriftItemSummary | A drift item from the list.
dsCredentials | Parameters passed to log in to DSM.
Entity |
error | Structure for errors returned from the REST API
Event | An Application Control event.
Event | An integrity event.
Event | An integrity event.
EventBasedTask | Details of an event-based task.
EventObject |
FeatureSummary | Container for feature summary
FeatureSummaryDetailElement |
GenerateReportTaskParameters | Parameters for generate report task.
GetAwsAccountResponse | Response object for the AWS Account API
GetInventoryResponse | Response object for the GetInventory API.
Histogram | A list of buckets, with a number of items associated with each bucket.
host | Representation of a DSM-managed Host, used for communication between the DSM and REST API users.
HostFilter | Details of a host filter.
hosts |
HostStatusSummary |
InventoryItem | Detailed information about an application inventory item.
inventoryMetadata | Inventory metadata details.
Item | A list item, i.e.
Item | A list item, i.e.
Jobs | Manager node job assignments.
JVMUsage | Information about how a Deep Security Manager node has used the Java Virtual Machine (JVM).
JVMUsageListing | A list of Java Virtual Machine statistics
licenseInfoElement | Object for storing information about license for specific module such as activation code, expire date, grace date,...
ListAdministratorRolesResponse | Response object for the ListAdministratorRolesResponse API.
ListAdministratorsResponse | Response object for the ListAdministrators API.
ListApplicationDriftRequest | Request object for the ListApplicationDrift API.
ListApplicationDriftResponse | Response object for the ListApplicationDrift API.
ListCloudAccountsResponse | Response object for the Cloud Accounts API.
ListComputerDriftRequest | Request object for the ListComputerDrift API.
ListComputerDriftResponse | Response object for the ListComputerDrift API.
ListDecisionLogDetailsResponse | Response object for the ListDecisionLogDetails API.
ListDecisionLogsResponse | Response object for the ListDecisionLogs API.
ListDisplayElementsResponse | Response object that gets returned from the ListDisplayElements API method.
ListEventBasedTasksResponse | Response object for the ListEventBasedTasksResponse API.
ListEventsResponse | Response object for the ListEvents API.
ListEventsResponse | Response object for the ListEvents API.
ListEventsResponse | Response object for the ListEvents API.
ListHostGroupsRequest | Request object for the ListHostGroups API.
ListHostGroupsResponse | Response object for the ListHostGroups API.
ListHostsResponse | Response object for the ListHosts API
ListInventoriesResponse |
ListLicenseResponse | Response object for the listLicenseInfo API.
ListManagerNodesResponse | Response object for the ListManagerNodes API.
ListNewsEntriesResponse | Response object for the News Feed API.
ListParentSmartFolderResponse | Response object that gets returned from the ListParentSmartFolder API method.
ListProxiesResponse | Response object for the ListProxies API.
ListQueryDefinitionsResponse | Response object that gets returned from the ListQueryDefinitions API method
ListReportTemplatesResponse | Response object for the ListReportTemplatesResponse API.
ListRulesetsResponse |
ListSAMLIdentityProvidersResponse | Response object for the ListSAMLIdentityProviders API.
ListScheduledTasksResponse | Response object for the ListScheduledTasksResponse API.
ListScriptsResponse | Response object for the ListScriptsResponse API.
ListSmartFoldersResponse | Response object that gets returned from the ListSmartFolders API method.
ListSSLConfigurationsResponse | Response object for the ListSSLConfigurations API
ListSyslogConfigurationsResponse | Response object for the ListSyslogConfigurations API.
Location | Addressing information for a manager node.
ManagerNode | Manager node details.
Memory | Manager node memory information.
ModifyAdministratorRequest | Request object for the ModifyAdministrator API.
ModifyAdministratorRoleHostGroupsRequest | Request object for the ModifyAdministratorRoleHostGroups API.
ModifyAdministratorRoleHostsRequest | Request object for the ModifyAdministratorRoleHosts API.
ModifyAdministratorRolePoliciesRequest | Request object for the ModifyAdministratorRolePolicies API.
ModifyAdministratorRoleRequest | Request object for the ModifyAdministratorRole API.
ModifyAdministratorRoleResponse | Response object for the ModifyAdministratorRole API.
ModifyAdministratorRoleRightsRequest | Request object for the ModifyAdministratorRoleRights API.
ModifyAdministratorsListRequest | Request object for the ModifyAdministratorsList API.
ModifyAdministratorsListResponse | Response object for the ModifyAdministratorsList API.
ModifyApplicationControlPolicyRequest | Request object for the ModifyApplicationControlPolicy API.
ModifyContactsListRequest | Request object for the ModifyContactsList API.
ModifyContactsListResponse | Response object for the ModifyContactsList API.
ModifyManagerNodeRequest | Request object for the ModifyManagerNode API.
ModifyManagerNodeResponse | Response object for the ModifyManagerNode API.
ModifyProxyRequest | Request object for the ModifyProxy API.
ModifySAMLIdentityProviderRequest | Request object for the ModifySAMLIdentityProvider API.
ModifySAMLIdentityProviderResponse | Response object for the ModifySAMLIdentityProvider API.
ModifySAMLServiceProviderRequest | Request object for the ModifySAMLServiceProvider API.
ModifySAMLServiceProviderResponse | Response object for the ModifySAMLServiceProvider API.
ModifyScheduledTaskRequest | Request object for the ModifyScheduledTask API.
ModifyScheduledTaskResponse | Response object for the ModifyScheduledTask API.
ModifySSLConfigurationRequest | Request object for the ModifySSLConfiguration API
ModifySSLConfigurationResponse | Response object for the ModifySSLConfiguration API
ModifySyslogConfigurationRequest | Request object for the ModifySyslogConfiguration API.
ModifySyslogConfigurationResponse | Response object for the ModifySyslogConfiguration API.
ModifyTrustedUpdateModeRequest | Request object for the ModifyTrustedUpdateMode API.
MonthlyScheduleParameters | Parameters for monthly schedule
multiTenantConfiguration | A structure containing information about the Multi-Tenant Configuration.
NewsEntry | Response object for the News Feed API.
OccurrencesForApplicationRequest | A request for a list of occurrences of a given application, including a scope and pagination data.
OccurrencesForComputerRequest | A request for a list of occurrences of a given application, including a scope and pagination data.
ParentSmartFolderSummary | Details of a Smart Folder
PolicySummaryInfo | Summary information about a policy.
PropertyFilter | An optional property filter for queries, allowing "contains" filtering based on the properties of the drift item.
Proxy | Proxy details.
query | A Smart Folder query
QueryDefinition | A Smart Folder Query Definition.
QueryDefinitionElement | A Smart Folder Query Definition Element.
QueryDefinitionGroup | A Group of Smart Folder Query Definitions, used to populate the list of Properties in the GUI
queryGroups | A Smart Folder Query Group
QueryGroupSummary | Details of a Query Group
QuerySummary | Details of a Query
Recipients | Recipients.
ReportTemplate | Report template details.
ReviewApplicationDriftRequest | Request object for the ReviewApplicationDrift API.
ReviewApplicationDriftResponse | Response object for the ReviewApplicationDrift API.
ReviewComputerDriftRequest | Request object for the ReviewComputerDrift API.
ReviewComputerDriftResponse | Response object for the ReviewComputerDrift API.
ReviewDriftItemRequest | Request object for the ReviewDriftItem API.
ReviewDriftItemResponse | Response object for the ReviewDriftItem API.
Rule | Details of a rule.
Ruleset | Details of a ruleset.
RulesetSummary | Details of a ruleset.
RulesetSummaryInfo |
RunScriptTaskParameters | Parameters for run script task.
SAMLIdentityProvider | SAML identity provider details.
SAMLServiceProvider | SAML service provider details.
ScanForIntegrityChangesTaskParameters | Parameters for scan for integrity changes task.
ScanForMalwareTaskParameters | Parameters for scan for malware task.
ScanForOpenPortsTaskParameters | Parameters for scan for open ports task.
ScanForRecommendationsTaskParameters | Parameters for scan for recommendations task.
Schedule | Details of a schedule.
ScheduledTaskObject | Details of a scheduled task.
scope | A scope for a drift query, including time range and property filters.
scope | A scope for a drift query, including time range, property filters, and a host group or smart folder.
Script | Details of a script.
SendAlertSummaryTaskParameters | Parameters for send alert summary task.
SendPolicyTaskParameters | Parameters for send policy task.
serviceInfo | Service information for registering on DS
Session | Session details
SmartFolder | Details of a Smart Folder
SmartFolderSummary | Details of a Smart Folder
SSLConfiguration | Details of an SSL configuration.
SSLCredential | Details of an SSL credential.
Status | Manager node operational status information.
StatusSummary |
SuspiciousObjectsDeployError |
SuspiciousObjectsUpdtaeError |
synchronizeCloudAccountResponse | Response returned after synchronizing a cloud account
SynchronizeCloudAccountTaskParameters | Parameters for synchronize cloud account task.
SynchronizeDirectoryTaskParameters | Parameters for synchronize directory task.
SynchronizeVCenterTaskParameters | Parameters for synchronize vcenter task.
SyslogConfiguration | Syslog configuration details.
SystemInformation | Manager node system information.
TagFilter |
tenant | A structure containing information about Tenant.
TenantAggregateHostProtection | A structure containing information about how much time a tenant's hosts have been protected for.
TenantAggregateHostProtectionListing | A listing of aggregate information about much time each tenant's host computers have been protected for.
tenantDatabaseServer | A structure encapsulating information about a database server.
tenantDatabaseServerListing | List of tenant database servers
TenantDatabaseUsage | A structure conveying information about how a tenant has been using the database.
TenantDatabaseUsageListing | A list of how tenants have been using the database.
tenantdblock | A structure containing information about tenant database lock
tenantDbLockListing | Listing of tenant databasck locks
TenantHostProtection | A record of a host's protection.
TenantHostProtectionListing | A listing of `TenantHostProtectionElement` elements.
tenantListing | Listing of tenants
TenantManagerUsage | A structure conveying information about how a tenant used a particular manager node.
TenantManagerUsageListing | A list of general information about how tenants have used a particular Deep Security Manager node.
TenantModuleUsage | A structure conveying information about a module extension to a Tenant Host Usage record
tenantTemplate | A structure containing information about the Tenant Template if one has been created.
TenantUsage | A structure conveying information about how a tenant has been using Deep Security Manager.
TenantUsageListing | A list of general information about how tenants have used the Deep Security Manager.
testCloudAccountResponse | Response returned when testing the connection to a cloud account
TimeRange | A time range with which to narrow down a drift query.
TimeRange |
Timestamps | Manager node lifecycle timestamps.
TriggerBuildInventoryRequest |
UpdateAdministratorResponse | Response object for the ModifyAdministrator API.
updateAntiMalwareScanConfigRequest | Provides options for the modification of an antiMalware scan configuration.
UpdateAwsAccountRequest | Request object for the AWS Account API.
updateCloudAccountRequest | Provides options for the modification of a cloud account.
updateCloudAccountResponse | Response returned when updating a cloud account
updateMultiTenantConfigurationRequest | Provides options for the multi-tenant configuration of DSM.
updateMultiTenantConfigurationResponse | Response returned after updating multi-tenant configuration completed successfully.
UpdateProxyResponse | Response object for the ModifyProxy API.
UpdateSmartFolderRequest | Request object for the UpdateSmartFolderRequest API.
UpdateSuspiciousObjectsListResponse |
UpdateSuspiciousObjectsListTaskParameters | Parameters for update suspicious objects list task.
updateTenantDatabaseServerRequest | Class encapsulating data/directive to be used for the modification of a tenant secondary database server.
updateTenantDatabaseServerResponse | Response returned after updating a tenant database server
updateTenantOptions | Attributes used or controlling the modification of a tenant.
updateTenantRequest | Class encapsulating data to be used for the modification of a tenant.
updateTenantResponse | Response returned after updating a tenant.
ValidateSmartFolderRequest | Request object for the CreateSmartFolder API method.
webReputationEvent | Web Reputation Event object to return in Restful API
WebReputationEventListing | Response object for the ListWebReputationEvents API.
webServiceRequest | Base class for all user-facing web service request objects.
WeeklyScheduleParameters | Parameters for weekly schedule.

Copyright © 2017 Trend Micro Inc. All Rights Reserved.