# Deep Security Manager REST API

Resources
Method | URL | Description
--- | --- | ---
`GET` | `/rest/apiVersion` | Return REST API version number.
`POST` | `/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.
`DELETE` | `/rest/authentication/logout?sID=…` | Ends the client session.
`GET` | `/rest/authentication/signinastenant/name/{tName}?sID=…` | SignIn as a tenant, and return a session ID (sID) to use in subsequent calls to other APIs.
`GET` | `/rest/cloudaccounts?sID=…` | List configuration of all cloud accounts (Amazon, vCloud Private Cloud).
`POST` | `/rest/cloudaccounts` | Add a new cloud account.
`GET` | `/rest/cloudaccounts/{cloudAccountId}?sID=…` | Get a specific cloud account.
`PUT` | `/rest/cloudaccounts/{cloudAccountId}` | Update cloud account information.
`DELETE` | `/rest/cloudaccounts/{cloudAccountId}?sID=…` | Delete a cloud account.
`PUT` | `/rest/cloudaccounts/{cloudAccountId}/synchronize?sID=…` | Synchronize a cloud account by ID.
`PUT` | `/rest/cloudaccounts/{cloudAccountId}/testconnection?sID=…` | Test a cloud account connection against its supporting cloud provider.
`GET` | `/rest/events/antimalware?eventId=…&eventIdOp=…&maxItems=…&sID=…` | Get AntiMalware events
`GET` | `/rest/events/antimalware/{eventId}?sID=…` | Get AntiMalware with specific event id.
`GET` | `/rest/events/antimalwareinmcp?eventId=…&eventIdOp=…&maxItems=…&header=…&sID=…` | Get AntiMalware events
`GET` | `/rest/events/payloadloginmcp?eventId=…&eventIdOp=…&maxItems=…&header=…&sID=…` | Get Payload Logs
`GET` | `/rest/events/webreputation?eventId=…&eventIdOp=…&maxItems=…&sID=…` | Get Web Reputation events
`GET` | `/rest/events/webreputation/{eventId}?sID=…` | Get Web Reputation event with specific event id.
`GET` | `/rest/events/webreputationinmcp?eventId=…&eventIdOp=…&maxItems=…&header=…&sID=…` | Get Web Reputation events
`GET` | `/rest/hosts/{hostId}/components?sID=…` | List the Components of the host.
`GET` | `/rest/hosts/{hostId}/virusPatterns?sID=…` | List the Virus Pattern Components of the host.
`POST` | `/rest/license/addActivationCode?moduleNumber=…&activationCode=…&sID=…` | Adds the activation code for the specified module
`GET` | `/rest/license/retrieveActivationCode?moduleNumber=…&sID=…` | Retrieves the current activation code for the specified module
`GET` | `/rest/managerInfo/components?sID=…` | return detail component info in current system
`GET` | `/rest/managerInfo/featureSummary?timescale=…&sID=…` | Get status summary of each protection feature
`GET` | `/rest/managerInfo/messageInMCP/logon?header=…&sID=…` | Return a LOGON message in MCP blob
`GET` | `/rest/managerInfo/productGUID?sID=…` | Return product GUID for TMCM to identify the server.
`GET` | `/rest/managerInfo/statusSummary?sID=…` | return the status summary of the system
`GET` | `/rest/managerInfo/version` | Return DSM version.
`GET` | `/rest/monitoring/usages/databases?tenantName=…&tID=…&from=…&to=…&sID=…` | List high-level database usage information.
`GET` | `/rest/monitoring/usages/hosts/aggregate/protection?tenantName=…&tID=…&from=…&to=…&sID=…` | List aggregate tenant computer protection information.
`GET` | `/rest/monitoring/usages/hosts/protection?tenantName=…&tID=…&from=…&to=…&sID=…` | List host protection information.
`GET` | `/rest/monitoring/usages/jvm?managerNodeID=…&from=…&to=…&sID=…` | List Java Virtual Machine statistics.
`GET` | `/rest/monitoring/usages/managers?tenantName=…&tID=…&managerNodeID=…&from=…&to=…&sID=…` | List information about how tenants have used the system, with results broken down by the Deep Security Manager node.
`GET` | `/rest/monitoring/usages/tenants?tenantName=…&tID=…&from=…&to=…&sID=…` | List general information about how tenants have used the system.
`GET` | `/rest/multitenantconfiguration?sID=…` | Configuration of DSM Multi Tenant settings.
`PUT` | `/rest/multitenantconfiguration` | Set the multi-tenant configuration.
`GET` | `/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?sID=…` | Retrieve information about all Tenant Database Servers.
`POST` | `/rest/tenantdatabaseservers` | Add a new Tenant Database Server.
`GET` | `/rest/tenantdatabaseservers/{tenantDatabaseServerId}?sID=…` | Get a specific Tenant Database Server.
`PUT` | `/rest/tenantdatabaseservers/{tenantDatabaseServerId}` | Update Tenant Database Server information.
`DELETE` | `/rest/tenantdatabaseservers/{tenantDatabaseServerId}?sID=…` | Delete tenant database server by ID.
`GET` | `/rest/tenants?sID=…` | Retrieve information about all tenants.
`POST` | `/rest/tenants` | Add a new tenant.
`GET` | `/rest/tenants/id/{tID}?sID=…` | Retrieve a tenant by tenant's ID.
`DELETE` | `/rest/tenants/id/{tID}?sID=…` | Delete tenant by tenant's ID.
`PUT` | `/rest/tenants/name/{tName}` | Update a tenant's information.
`GET` | `/rest/tenants/name/{tName}?sID=…` | Retrieve a tenant by name.
`DELETE` | `/rest/tenants/name/{tName}?sID=…` | Delete a tenant by name.
`GET` | `/rest/tenanttemplate?sID=…` | Retrieve the current tenant template.
`POST` | `/rest/tenanttemplate` | Create a new tenant template using the provided tenantId.
`GET` | `/rest/widgets/antimalware/malwareHistoryWidget?sID=…&timescale=…` | Get Anti-Malware events history data based on AntiMalwareHistoryWidget
`GET` | `/rest/widgets/antimalware/top5MalwareDetectedWidget?sID=…&timescale=…` | Get Top 5 detected Malware based on Top5MalwareDetectedWidget
`GET` | `/rest/widgets/antimalware/top5UrlsForWebReputationWidget?sID=…&timescale=…` | Get Top 5 Web Reputation URL Activity based on Top5UrlsForWebReputationWidget
`GET` | `/rest/widgets/antimalware/webReputationHistoryWidget?sID=…&timescale=…` | Get Web Reputation events history data based on WebReputationHistoryWidget
`GET` | `/rest/widgets/integrity/integrityHistoryWidget?sID=…&timescale=…` | Get Integrity Monitoring events history data based on IntegrityHistoryWidget
`GET` | `/rest/widgets/integrity/top5IntegrityRulesWidget?sID=…&timescale=…` | Get Top 5 Reasons for Integrity Monitoring Events based on Top5IntegrityRulesWidget
`GET` | `/rest/widgets/logInspection/logInspectionHistoryWidget?sID=…&timescale=…` | Get Log Inspection events history data based on LogInspectionHistoryWidget
`GET` | `/rest/widgets/logInspection/top5LogInspectionRulesWidget?sID=…&timescale=…` | Get Top 5 Reasons for Log Inspection Events
`GET` | `/rest/widgets/network/packetHistoryWidget?sID=…&timescale=…` | Get Firewall events history data based on PacketHistoryWidget
`GET` | `/rest/widgets/network/payloadLogHistoryWidget?sID=…&timescale=…` | Get Intrusion Prevention events history data based on PayloadLogHistoryWidget
`GET` | `/rest/widgets/network/top5ApplicationTypesDetectedWidget?sID=…&timescale=…` | Get Top 5 detected Application Type activity on Top5ApplicationTypesDetectedWidget
`GET` | `/rest/widgets/network/top5ApplicationTypesPreventedWidget?sID=…&timescale=…` | Get Top 5 prevented Application Type activity on Top5ApplicationTypesPreventedWidget
`GET` | `/rest/widgets/network/top5PacketsDetectedWidget?sID=…&timescale=…` | Get Top 5 detected firewall activity based on Top5PacketsDetectedWidget
`GET` | `/rest/widgets/network/top5PacketsPreventedWidget?sID=…&timescale=…` | Get Top 5 prevented firewall activity based on Top5PacketsPreventedWidget
`GET` | `/rest/widgets/network/top5PayloadDetectedWidget?sID=…&timescale=…` | Get Top 5 detected IPS activity on Top5PayloadDetectedWidget
`GET` | `/rest/widgets/network/top5PayloadPreventedWidget?sID=…&timescale=…` | Get Top 5 prevented IPS activity on Top5PayloadPreventedWidget
`GET` | `/rest/widgets/network/trafficAnalysisHistoryWidget?sID=…&timescale=…` | Get Traffic Analysis events history data based on TrafficAnalysisHistoryWidget

Copyright © 2015 Trend Micro Inc. All Rights Reserved.