# Deep Security Manager REST API

Resources
Method | URL | Description
--- | --- | ---
`GET` | `/rest/administrator-roles?administratorRoleID=…&administratorRoleIDOp=…&maxItems=…` | List administrator roles.
`POST` | `/rest/administrator-roles` | Create a new administrator role.
`GET` | `/rest/administrator-roles/{roleID}` | Describe an administrator role.
`POST` | `/rest/administrator-roles/{roleID}` | Modify an administrator role.
`DELETE` | `/rest/administrator-roles/{roleID}` | Delete an administrator role.
`PUT` | `/rest/administrator-roles/{roleID}/host-groups` | Update an administrator role with a new (complete) set of host groups.
`POST` | `/rest/administrator-roles/{roleID}/host-groups` | Update an administrator role with an additional set of host groups.
`DELETE` | `/rest/administrator-roles/{roleID}/host-groups/{hostGroupID}` | Remove a host group from an administrator role.
`PUT` | `/rest/administrator-roles/{roleID}/hosts` | Update an administrator role with a new (complete) set of hosts.
`POST` | `/rest/administrator-roles/{roleID}/hosts` | Update an administrator role with an additional set of hosts.
`DELETE` | `/rest/administrator-roles/{roleID}/hosts/{hostID}` | Remove a host from an administrator role.
`PUT` | `/rest/administrator-roles/{roleID}/policies` | Update an administrator role with a new (complete) set of policies.
`POST` | `/rest/administrator-roles/{roleID}/policies` | Update an administrator role with an additional set of policies.
`DELETE` | `/rest/administrator-roles/{roleID}/policies/{policyID}` | Remove a policy from an administrator role.
`PUT` | `/rest/administrator-roles/{roleID}/rights` | Update an administrator role with a new (complete) set of rights.
`POST` | `/rest/administrator-roles/{roleID}/rights` | Update an administrator role with an additional set of rights.
`DELETE` | `/rest/administrator-roles/{roleID}/rights/{rightID}` | Remove a right from an administrator role.
`GET` | `/rest/administrators?administratorID=…&administratorIDOp=…&maxItems=…` | List administrators.
`POST` | `/rest/administrators` | Create a new administrator.
`GET` | `/rest/administrators/{administratorID}` | Describe an administrator.
`POST` | `/rest/administrators/{administratorID}` | Modify an administrator.
`DELETE` | `/rest/administrators/{administratorID}` | Delete an administrator.
`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/nonce` | Authenticate an user, and return a temporary token for UI Single Sign On.
`POST` | `/rest/authentication/login/primary` | Authenticate a primary tenant user, and return a session ID (sID) to use in subsequent calls to other APIs.
`DELETE` | `/rest/authentication/logout?sID=…` | Ends the client session.
`GET` | `/rest/authentication/signinastenant/name/{tenantName}?sID=…` | Sign in as a tenant, and return a session ID (sID) to use in subsequent calls to other APIs.
`GET` | `/rest/cloudaccounts` | Lists all of the cloud accounts that are in Deep Security
`POST` | `/rest/cloudaccounts` | Add a new cloud account.
`POST` | `/rest/cloudaccounts/aws` | Adds a new AWS cloud account into Deep Security
`DELETE` | `/rest/cloudaccounts/aws/{internalID}` | Deletes an AWS cloud account from Deep Security
`GET` | `/rest/cloudaccounts/aws/{internalID}` | Gets information about the specified AWS cloud account
`POST` | `/rest/cloudaccounts/aws/{internalID}/sync` | Forces a sync of the specified AWS cloud account
`POST` | `/rest/cloudaccounts/aws/{internalID}/update` | Update the specified AWS 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/decision-logs?decisionLogID=…&decisionLogIDOp=…&decisionLogUtcTime=…&decisionLogUtcTimeOp=…&maxItems=…` | Get Application Control Decision Logs.
`GET` | `/rest/decision-logs/{decisionLogID}` | Get the Application Control decision log with the specified log ID.
`GET` | `/rest/decision-logs/{decisionLogID}/details?startID=…&count=…` | Get the Application Control decision log details with the specified log ID and start and count.
`POST` | `/rest/decision-logs/{decisionLogID}/undo` | Undo the Application Control decision log with the specified log ID.
`GET` | `/rest/events/antimalware?eventId=…&eventIdOp=…&maxItems=…&eventTime=…&eventTimeOp=…&sID=…` | Get AntiMalware events
`GET` | `/rest/events/antimalware/{eventID}?sID=…` | Get AntiMalware with specific event id.
`GET` | `/rest/events/appcontrol?eventID=…&eventIDOp=…&eventTime=…&eventTimeOp=…&maxItems=…` | Get Application Control events.
`GET` | `/rest/events/appcontrol/{eventID}` | Get the Application Control event with the specified event ID.
`GET` | `/rest/events/integrity?eventID=…&eventIDOp=…&eventTime=…&eventTimeOp=…&maxItems=…&extendedDesc=…` | Get Integrity events.
`GET` | `/rest/events/integrity/{eventID}?extendedDesc=…` | Get the Integrity event with the specified event ID.
`GET` | `/rest/events/logInspection?eventID=…&eventIDOp=…&eventTime=…&eventTimeOp=…&maxItems=…` | Get log inspection events.
`GET` | `/rest/events/logInspection/{eventID}` | Get the Log Inspection event with the specified event ID.
`GET` | `/rest/events/webreputation?eventId=…&eventIdOp=…&maxItems=…&eventTime=…&eventTimeOp=…&sID=…` | Get Web Reputation events
`GET` | `/rest/events/webreputation/{eventID}?sID=…` | Get Web Reputation event with specific event id.
`GET` | `/rest/hosts` | Gets a JSON or XML summary of each host in the DSM database.
`GET` | `/rest/hosts/hostname/{hostname}` | Gets a JSON or XML summary of hosts with the given host name.
`GET` | `/rest/hosts/instanceid/{instanceID}` | Gets a JSON or XML summary of hosts with the given instance ID.
`GET` | `/rest/hosts/{hostID}` | Get information about a single host by host ID.
`GET` | `/rest/hosts/{hostID}/components?sID=…` | List the Components of the host.
`POST` | `/rest/hosts/{hostID}/intrusion-prevention/ssl-configurations` | Create a new SSL configuration.
`GET` | `/rest/hosts/{hostID}/intrusion-prevention/ssl-configurations?sslConfigurationID=…&sslConfigurationIDOp=…&maxItems=…` | List SSL configurations.
`GET` | `/rest/hosts/{hostID}/intrusion-prevention/ssl-configurations/{id}` | Get details of an SSL configuration.
`POST` | `/rest/hosts/{hostID}/intrusion-prevention/ssl-configurations/{id}` | Modify an SSL configuration.
`DELETE` | `/rest/hosts/{hostID}/intrusion-prevention/ssl-configurations/{id}` | Delete an SSL configuration.
`POST` | `/rest/hosts/{hostID}/trusted-update-mode` | Modify the settings for trusted update mode on a host.
`GET` | `/rest/hosts/{hostID}/trusted-update-mode` | Get the settings for trusted update mode on a host.
`GET` | `/rest/hosts/{hostID}/virusPatterns?sID=…` | List the Virus Pattern Components of the host.
`GET` | `/rest/identity-providers/saml?id=…&op=…&maxItems=…` | List SAML identity providers.
`POST` | `/rest/identity-providers/saml` | Create a new SAML identity provider.
`GET` | `/rest/identity-providers/saml/{samlIdentityProviderID}` | Describe a SAML identity provider.
`POST` | `/rest/identity-providers/saml/{samlIdentityProviderID}` | Modify a SAML identity provider.
`DELETE` | `/rest/identity-providers/saml/{samlIdentityProviderID}` | Delete a SAML identity provider.
`POST` | `/rest/license/addActivationCode?moduleNumber=…&activationCode=…&sID=…` | Adds the activation code for the specified module
`GET` | `/rest/license/listLicenseInfo?module=…` | List all the license information or based on the specified module name
`GET` | `/rest/license/retrieveActivationCode?moduleNumber=…&sID=…` | Retrieves the current activation code for the specified module
`GET` | `/rest/license/retrieveLicenseInfo?moduleNumber=…&sID=…` | Retrieves the current activation code for the specified module
`GET` | `/rest/manager-nodes?id=…&op=…&maxItems=…` | List manager nodes.
`GET` | `/rest/manager-nodes/{managerNodeID}` | Describe a manager node.
`POST` | `/rest/manager-nodes/{managerNodeID}` | Modify a manager node.
`DELETE` | `/rest/manager-nodes/{managerNodeID}` | Delete a manager node.
`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/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/newsfeed?background=…` | Get the meta data about the news feed
`GET` | `/rest/newsfeed/entries?all=…&entryID=…&entryIDOp=…&maxItems=…` | List the entries from the news feed.
`DELETE` | `/rest/newsfeed/entries/{entryID}` | Dismisses a news entry
`GET` | `/rest/policies/antimalware/scanConfigs?sID=…` | Retrieve All AntiMalware Scan Configurations
`POST` | `/rest/policies/antimalware/scanConfigs` | Add an AntiMalware Scan Configuration
`GET` | `/rest/policies/antimalware/scanConfigs/{scanConfigID}?sID=…` | Retrieve AntiMalware Scan Configurations by scan configuration ID
`PUT` | `/rest/policies/antimalware/scanConfigs/{scanConfigID}` | Update an AntiMalware Scan Configurations
`DELETE` | `/rest/policies/antimalware/scanConfigs/{scanConfigID}?sID=…` | Delete an AntiMalware Scan Configurations
`GET` | `/rest/policies/{policyID}/application-control` | Retrieve the application control settings for a policy.
`POST` | `/rest/policies/{policyID}/application-control` | Modify the application control portion of a policy.
`GET` | `/rest/proxies?id=…&op=…&maxItems=…` | List proxies.
`POST` | `/rest/proxies` | Create a new proxy.
`GET` | `/rest/proxies/{proxyID}` | Describe a proxy.
`POST` | `/rest/proxies/{proxyID}` | Modify a proxy.
`DELETE` | `/rest/proxies/{proxyID}` | Delete a proxy.
`GET` | `/rest/reports?id=…&op=…&maxItems=…` | List report templates.
`POST` | `/rest/rulesets` | Create a new ruleset.
`GET` | `/rest/rulesets?rulesetID=…&rulesetIDOp=…&maxItems=…` | Retrieve a list of rulesets.
`GET` | `/rest/rulesets/{rulesetID}?ruleID=…&ruleIDOp=…&maxItems=…` | Gets the contents of one ruleset.
`DELETE` | `/rest/rulesets/{rulesetID}` | Deletes a ruleset from the Deep Security Manager.
`GET` | `/rest/scripts?id=…&op=…&maxItems=…` | List scripts.
`GET` | `/rest/service-provider/saml` | Describe the SAML service provider.
`POST` | `/rest/service-provider/saml` | Modify the SAML service provider.
`GET` | `/rest/session` | Describe a session.
`DELETE` | `/rest/session` | End a session.
`POST` | `/rest/session` | Assume a role using a SAML response from an authorized identity provider.
`POST` | `/rest/smart-folders` | Creates a new smart folder.
`GET` | `/rest/smart-folders` | Returns a list of all Smart Folders.
`POST` | `/rest/smart-folders/{smartFolderID}` | Updates a smart folder.
`GET` | `/rest/smart-folders/{smartFolderID}` | Gets the details of one smart folder.
`DELETE` | `/rest/smart-folders/{smartFolderID}` | Deletes a smart folder.
`POST` | `/rest/smart-folders/{smartFolderID}/synchronize` | Synchronizes a smart folder.
`POST` | `/rest/software-inventory` | Create an inventory of a host.
`GET` | `/rest/software-inventory?inventoryID=…&inventoryIDOp=…&maxItems=…` | Retrieve the list of all inventory metadata.
`POST` | `/rest/software-inventory/drift/applications` | Gets the list of unreviewed applications, grouped by SHA256, within the provided search scope.
`POST` | `/rest/software-inventory/drift/applications/{sha256}/action` | Performs an allow or block action on all instances of the given application, identified by SHA256, within the provided search scope scope.
`POST` | `/rest/software-inventory/drift/applications/{sha256}/details` | Gets details about a given executable, identified by sha256, using inventory change data within the provided search scope.
`POST` | `/rest/software-inventory/drift/applications/{sha256}/occurrences` | Gets a list of the instances of the given unreviewed application, identified by SHA256, within the provided search scope.
`POST` | `/rest/software-inventory/drift/computers` | Gets the list of hosts that have had unreviewed drift items within the provided search scope.
`POST` | `/rest/software-inventory/drift/computers/{hostID}/action` | Performs an allow or block action on all drift items on the given host ID within the provided search scope.
`POST` | `/rest/software-inventory/drift/computers/{hostID}/occurrences` | Gets a list of all unreviewed drift items within the provided search scope.
`POST` | `/rest/software-inventory/drift/histogram` | Gets metadata describing the drift that has occurred within the provided search scope.
`POST` | `/rest/software-inventory/drift/host-groups` | Gets the tree of all host groups with hosts that have had unreviewed inventory changes within the provided search scope.
`GET` | `/rest/software-inventory/drift/occurrences/{changeID}` | Gets computer and file details for the provided inventory change.
`POST` | `/rest/software-inventory/drift/occurrences/{changeID}/action` | Performs an allow or block action on one inventory change.
`GET` | `/rest/software-inventory/{inventoryID}` | Retrieve inventory list metadata.
`DELETE` | `/rest/software-inventory/{inventoryID}` | Delete an inventory list.
`GET` | `/rest/software-inventory/{inventoryID}/details?itemID=…&itemIDOp=…&maxItems=…` | Retrieve inventory list details.
`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/support/hosts/{hostID}/diagnostics-package` | Retrieve the agent diagnostics package for a specific host.
`GET` | `/rest/support/manager/diagnostics-package?verbose=…` | Retrieve the manager diagnostics package.
`POST` | `/rest/suspicious-objects?update=…&deploy=…` | Update the suspicious objects list.
`DELETE` | `/rest/suspicious-objects` | Clear the suspicious objects list
`POST` | `/rest/syslog-configurations` | Create a syslog configuration.
`GET` | `/rest/syslog-configurations?syslogConfigurationID=…&syslogConfigurationIDOp=…&maxItems=…` | List syslog configurations.
`GET` | `/rest/syslog-configurations/{syslogConfigurationID}` | Get syslog configuration details.
`POST` | `/rest/syslog-configurations/{syslogConfigurationID}` | Modify syslog configuration.
`DELETE` | `/rest/syslog-configurations/{syslogConfigurationID}` | Delete a syslog configuration from the Deep Security Manager.
`POST` | `/rest/tasks/event-based` | Create a new event-based task.
`GET` | `/rest/tasks/event-based` | List event-based tasks.
`DELETE` | `/rest/tasks/event-based/{id}` | Delete an event-based task.
`GET` | `/rest/tasks/scheduled?id=…&op=…&maxItems=…` | List scheduled tasks.
`POST` | `/rest/tasks/scheduled?runNow=…` | Create a new scheduled task.
`GET` | `/rest/tasks/scheduled/{scheduledTaskID}` | Describe a scheduled task.
`POST` | `/rest/tasks/scheduled/{scheduledTaskID}?runNow=…` | Modify a scheduled task.
`DELETE` | `/rest/tasks/scheduled/{scheduledTaskID}` | Delete a scheduled task.
`PUT` | `/rest/tasks/scheduled/{scheduledTaskID}/recipients/administrators` | Modify a scheduled task's recipients list with a new (complete) list of administrators.
`POST` | `/rest/tasks/scheduled/{scheduledTaskID}/recipients/administrators` | Modify a scheduled task's recipients list to add administrators.
`DELETE` | `/rest/tasks/scheduled/{scheduledTaskID}/recipients/administrators/{administratorID}` | Remove an administrator from a scheduled task's recipients list.
`PUT` | `/rest/tasks/scheduled/{scheduledTaskID}/recipients/contacts` | Modify a scheduled task's recipients list with a new (complete) list of contacts.
`POST` | `/rest/tasks/scheduled/{scheduledTaskID}/recipients/contacts` | Modify a scheduled task's recipients list with additional contacts.
`DELETE` | `/rest/tasks/scheduled/{scheduledTaskID}/recipients/contacts/{contactID}` | Remove a contact from a scheduled task's recipients list
`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/tenants/state/{state}?sID=…&tenantID=…&tenantIDOp=…&maxItems=…` | Get tenants by tenant state
`GET` | `/rest/tenanttemplate?sID=…` | Retrieve the current tenant template.
`POST` | `/rest/tenanttemplate` | Create a new tenant template using the provided tenantId.

Copyright © 2017 Trend Micro Inc. All Rights Reserved.