Deep Security Manager REST API


Resources
ResourceDescriptionMethods
/rest/apiVersionReturn REST API version number.GET
/rest/authentication/loginAuthenticate a user, and return a session ID (sID) to use in subsequent calls to other APIs.POST
/rest/authentication/login/primaryAuthenticate a primary tenant user, and return a session ID (sID) to use in subsequent calls to other APIs.POST
/rest/authentication/login/ssoAuthenticate a user, and return a session token for UI Single Sign On.POST
/rest/authentication/logoutEnds 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/cloudaccountsList 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}/synchronizeSynchronize a cloud account by ID.PUT
/rest/cloudaccounts/{cloudAccountId}/testconnectionTest a cloud account connection against its supporting cloud provider.PUT
/rest/events/antimalwareGet AntiMalware eventsGET
/rest/events/antimalware/{eventId}Get AntiMalware with specific event id.GET
/rest/events/antimalwareinmcpGet AntiMalware eventsGET
/rest/events/payloadloginmcpGet Payload LogsGET
/rest/events/webreputationGet Web Reputation eventsGET
/rest/events/webreputation/{eventId}Get Web Reputation event with specific event id.GET
/rest/events/webreputationinmcpGet Web Reputation eventsGET
/rest/hosts/{hostId}/componentsList the Components of the host.GET
/rest/hosts/{hostId}/virusPatternsList the Virus Pattern Components of the host.GET
/rest/license/addActivationCodeAdds the activation code for the specified modulePOST
/rest/license/retrieveActivationCodeRetrieves the current activation code for the specified moduleGET
/rest/managerInfo/componentsreturn detail component info in current systemGET
/rest/managerInfo/featureSummaryGet status summary of each protection featureGET
/rest/managerInfo/messageInMCP/logonReturn a LOGON message in MCP blobGET
/rest/managerInfo/productGUIDReturn product GUID for TMCM to identify the server.GET
/rest/managerInfo/statusSummaryreturn the status summary of the systemGET
/rest/managerInfo/versionReturn DSM version.GET
/rest/monitoring/usages/databasesList high-level database usage information.GET
/rest/monitoring/usages/hosts/aggregate/protectionList aggregate tenant computer protection information.GET
/rest/monitoring/usages/hosts/protectionList host protection information.GET
/rest/monitoring/usages/jvmList Java Virtual Machine statistics.GET
/rest/monitoring/usages/managersList information about how tenants have used the system, with results broken down by the Deep Security Manager node.GET
/rest/monitoring/usages/tenantsList general information about how tenants have used the system.GET
/rest/multitenantconfigurationConfiguration 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/pingQuery 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/pingQuery 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/tenantdatabaseserversRetrieve information about all Tenant Database Servers.GET, POST
/rest/tenantdatabaseservers/{tenantDatabaseServerId}Get a specific Tenant Database Server.GET, PUT, DELETE
/rest/tenantsRetrieve 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/tenanttemplateRetrieve the current tenant template.GET, POST
/rest/widgets/antimalware/malwareHistoryWidgetGet Anti-Malware events history data based on AntiMalwareHistoryWidgetGET
/rest/widgets/antimalware/top5MalwareDetectedWidgetGet Top 5 detected Malware based on Top5MalwareDetectedWidgetGET
/rest/widgets/antimalware/top5UrlsForWebReputationWidgetGet Top 5 Web Reputation URL Activity based on Top5UrlsForWebReputationWidgetGET
/rest/widgets/antimalware/webReputationHistoryWidgetGet Web Reputation events history data based on WebReputationHistoryWidgetGET
/rest/widgets/integrity/integrityHistoryWidgetGet Integrity Monitoring events history data based on IntegrityHistoryWidgetGET
/rest/widgets/integrity/top5IntegrityRulesWidgetGet Top 5 Reasons for Integrity Monitoring Events based on Top5IntegrityRulesWidgetGET
/rest/widgets/logInspection/logInspectionHistoryWidgetGet Log Inspection events history data based on LogInspectionHistoryWidgetGET
/rest/widgets/logInspection/top5LogInspectionRulesWidgetGet Top 5 Reasons for Log Inspection EventsGET
/rest/widgets/network/packetHistoryWidgetGet Firewall events history data based on PacketHistoryWidgetGET
/rest/widgets/network/payloadLogHistoryWidgetGet Intrusion Prevention events history data based on PayloadLogHistoryWidgetGET
/rest/widgets/network/top5ApplicationTypesDetectedWidgetGet Top 5 detected Application Type activity on Top5ApplicationTypesDetectedWidgetGET
/rest/widgets/network/top5ApplicationTypesPreventedWidgetGet Top 5 prevented Application Type activity on Top5ApplicationTypesPreventedWidgetGET
/rest/widgets/network/top5PacketsDetectedWidgetGet Top 5 detected firewall activity based on Top5PacketsDetectedWidgetGET
/rest/widgets/network/top5PacketsPreventedWidgetGet Top 5 prevented firewall activity based on Top5PacketsPreventedWidgetGET
/rest/widgets/network/top5PayloadDetectedWidgetGet Top 5 detected IPS activity on Top5PayloadDetectedWidgetGET
/rest/widgets/network/top5PayloadPreventedWidgetGet Top 5 prevented IPS activity on Top5PayloadPreventedWidgetGET
/rest/widgets/network/trafficAnalysisHistoryWidgetGet Traffic Analysis events history data based on TrafficAnalysisHistoryWidgetGET

Copyright © 2015 Trend Micro Inc. All Rights Reserved.