# Deep Security Manager REST API

Resources
Resource | Description | Methods
--- | --- | ---
`/rest/apiVersion` | Return REST API version number. | `GET`
`/rest/authentication/login` | Authenticate a user, and return a session ID (sID) to use in subsequent calls to other APIs. | `POST`
`/rest/authentication/login/primary` | Authenticate a primary tenant user, and return a session ID (sID) to use in subsequent calls to other APIs. | `POST`
`/rest/authentication/login/sso` | Authenticate a user, and return a session token for UI Single Sign On. | `POST`
`/rest/authentication/logout` | Ends the client session. | `DELETE`
`/rest/authentication/signinastenant/name/{tName}` | SignIn as a tenant, and return a session ID (sID) to use in subsequent calls to other APIs. | `GET`
`/rest/cloudaccounts` | List configuration of all cloud accounts (Amazon, vCloud Private Cloud). | `GET`, `POST`
`/rest/cloudaccounts/{cloudAccountId}` | Get a specific cloud account. | `GET`, `PUT`, `DELETE`
`/rest/cloudaccounts/{cloudAccountId}/synchronize` | Synchronize a cloud account by ID. | `PUT`
`/rest/cloudaccounts/{cloudAccountId}/testconnection` | Test a cloud account connection against its supporting cloud provider. | `PUT`
`/rest/events/antimalware` | Get AntiMalware events | `GET`
`/rest/events/antimalware/{eventId}` | Get AntiMalware with specific event id. | `GET`
`/rest/events/antimalwareinmcp` | Get AntiMalware events | `GET`
`/rest/events/payloadloginmcp` | Get Payload Logs | `GET`
`/rest/events/webreputation` | Get Web Reputation events | `GET`
`/rest/events/webreputation/{eventId}` | Get Web Reputation event with specific event id. | `GET`
`/rest/events/webreputationinmcp` | Get Web Reputation events | `GET`
`/rest/hosts/{hostId}/components` | List the Components of the host. | `GET`
`/rest/hosts/{hostId}/virusPatterns` | List the Virus Pattern Components of the host. | `GET`
`/rest/license/addActivationCode` | Adds the activation code for the specified module | `POST`
`/rest/license/retrieveActivationCode` | Retrieves the current activation code for the specified module | `GET`
`/rest/managerInfo/components` | return detail component info in current system | `GET`
`/rest/managerInfo/featureSummary` | Get status summary of each protection feature | `GET`
`/rest/managerInfo/messageInMCP/logon` | Return a LOGON message in MCP blob | `GET`
`/rest/managerInfo/productGUID` | Return product GUID for TMCM to identify the server. | `GET`
`/rest/managerInfo/statusSummary` | return the status summary of the system | `GET`
`/rest/managerInfo/version` | Return DSM version. | `GET`
`/rest/monitoring/usages/databases` | List high-level database usage information. | `GET`
`/rest/monitoring/usages/hosts/aggregate/protection` | List aggregate tenant computer protection information. | `GET`
`/rest/monitoring/usages/hosts/protection` | List host protection information. | `GET`
`/rest/monitoring/usages/jvm` | List Java Virtual Machine statistics. | `GET`
`/rest/monitoring/usages/managers` | List information about how tenants have used the system, with results broken down by the Deep Security Manager node. | `GET`
`/rest/monitoring/usages/tenants` | List general information about how tenants have used the system. | `GET`
`/rest/multitenantconfiguration` | Configuration of DSM Multi Tenant settings. | `GET`, `PUT`
`/rest/status/manager/current/item/{item}` | Query current manager node for a specific item Please check the status/manager/item/{item} documentation for valid item keywords. | `GET`
`/rest/status/manager/current/item/{item}/{warningThreshold}` | Query current manager node for a specific item with the desired threshold Please check the status/manager/item/{item} documentation for valid item keywords. | `GET`
`/rest/status/manager/current/ping` | Query the status of current manager node under default thresholds for each item. | `GET`
`/rest/status/manager/item/{item}` | Query a specific item for all available manager nodes under the default fail rate and threshold for this item. | `GET`
`/rest/status/manager/item/{item}/{failRate}` | Query a specific item for all available manager nodes by the desired fail rate but using default threshold. | `GET`
`/rest/status/manager/item/{item}/{failRate}/{warningThreshold}` | Query a specific item for all available manager nodes by the desired fail rate and threshold. | `GET`
`/rest/status/manager/ping` | Query all available manager nodes under default fail rate and thresholds for each item. | `GET`
`/rest/status/manager/ping/{failRate}` | Query all available manager nodes under the desired fail rate but using default thresholds for each item. | `GET`
`/rest/tenantdatabaseservers` | Retrieve information about all Tenant Database Servers. | `GET`, `POST`
`/rest/tenantdatabaseservers/{tenantDatabaseServerId}` | Get a specific Tenant Database Server. | `GET`, `PUT`, `DELETE`
`/rest/tenants` | Retrieve information about all tenants. | `GET`, `POST`
`/rest/tenants/id/{tID}` | Retrieve a tenant by tenant's ID. | `GET`, `DELETE`
`/rest/tenants/name/{tName}` | Retrieve a tenant by name. | `PUT`, `GET`, `DELETE`
`/rest/tenanttemplate` | Retrieve the current tenant template. | `GET`, `POST`
`/rest/widgets/antimalware/malwareHistoryWidget` | Get Anti-Malware events history data based on AntiMalwareHistoryWidget | `GET`
`/rest/widgets/antimalware/top5MalwareDetectedWidget` | Get Top 5 detected Malware based on Top5MalwareDetectedWidget | `GET`
`/rest/widgets/antimalware/top5UrlsForWebReputationWidget` | Get Top 5 Web Reputation URL Activity based on Top5UrlsForWebReputationWidget | `GET`
`/rest/widgets/antimalware/webReputationHistoryWidget` | Get Web Reputation events history data based on WebReputationHistoryWidget | `GET`
`/rest/widgets/integrity/integrityHistoryWidget` | Get Integrity Monitoring events history data based on IntegrityHistoryWidget | `GET`
`/rest/widgets/integrity/top5IntegrityRulesWidget` | Get Top 5 Reasons for Integrity Monitoring Events based on Top5IntegrityRulesWidget | `GET`
`/rest/widgets/logInspection/logInspectionHistoryWidget` | Get Log Inspection events history data based on LogInspectionHistoryWidget | `GET`
`/rest/widgets/logInspection/top5LogInspectionRulesWidget` | Get Top 5 Reasons for Log Inspection Events | `GET`
`/rest/widgets/network/packetHistoryWidget` | Get Firewall events history data based on PacketHistoryWidget | `GET`
`/rest/widgets/network/payloadLogHistoryWidget` | Get Intrusion Prevention events history data based on PayloadLogHistoryWidget | `GET`
`/rest/widgets/network/top5ApplicationTypesDetectedWidget` | Get Top 5 detected Application Type activity on Top5ApplicationTypesDetectedWidget | `GET`
`/rest/widgets/network/top5ApplicationTypesPreventedWidget` | Get Top 5 prevented Application Type activity on Top5ApplicationTypesPreventedWidget | `GET`
`/rest/widgets/network/top5PacketsDetectedWidget` | Get Top 5 detected firewall activity based on Top5PacketsDetectedWidget | `GET`
`/rest/widgets/network/top5PacketsPreventedWidget` | Get Top 5 prevented firewall activity based on Top5PacketsPreventedWidget | `GET`
`/rest/widgets/network/top5PayloadDetectedWidget` | Get Top 5 detected IPS activity on Top5PayloadDetectedWidget | `GET`
`/rest/widgets/network/top5PayloadPreventedWidget` | Get Top 5 prevented IPS activity on Top5PayloadPreventedWidget | `GET`
`/rest/widgets/network/trafficAnalysisHistoryWidget` | Get Traffic Analysis events history data based on TrafficAnalysisHistoryWidget | `GET`

Copyright © 2015 Trend Micro Inc. All Rights Reserved.