# Deep Security Manager REST API

Resources
Resource | Description | Methods
--- | --- | ---
`/rest/administrator-roles` | List administrator roles. | `GET`, `POST`
`/rest/administrator-roles/{roleID}` | Describe an administrator role. | `GET`, `POST`, `DELETE`
`/rest/administrator-roles/{roleID}/host-groups` | Update an administrator role with an additional set of host groups. | `PUT`, `POST`
`/rest/administrator-roles/{roleID}/host-groups/{hostGroupID}` | Remove a host group from an administrator role. | `DELETE`
`/rest/administrator-roles/{roleID}/hosts` | Update an administrator role with an additional set of hosts. | `PUT`, `POST`
`/rest/administrator-roles/{roleID}/hosts/{hostID}` | Remove a host from an administrator role. | `DELETE`
`/rest/administrator-roles/{roleID}/policies` | Update an administrator role with an additional set of policies. | `PUT`, `POST`
`/rest/administrator-roles/{roleID}/policies/{policyID}` | Remove a policy from an administrator role. | `DELETE`
`/rest/administrator-roles/{roleID}/rights` | Update an administrator role with an additional set of rights. | `PUT`, `POST`
`/rest/administrator-roles/{roleID}/rights/{rightID}` | Remove a right from an administrator role. | `DELETE`
`/rest/administrators` | List administrators. | `GET`, `POST`
`/rest/administrators/{administratorID}` | Describe an administrator. | `GET`, `POST`, `DELETE`
`/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/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. | `POST`
`/rest/authentication/logout` | Ends the client session. | `DELETE`
`/rest/authentication/signinastenant/name/{tenantName}` | 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 | `GET`, `POST`
`/rest/cloudaccounts/aws` | Adds a new AWS cloud account into Deep Security | `POST`
`/rest/cloudaccounts/aws/{internalID}` | Gets information about the specified AWS cloud account | `DELETE`, `GET`
`/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 | `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/decision-logs` | 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` | Get the Application Control decision log details with the specified log ID and start and count. | `GET`
`/rest/decision-logs/{decisionLogID}/undo` | Undo the Application Control decision log with the specified log ID. | `POST`
`/rest/events/antimalware` | Get AntiMalware events | `GET`
`/rest/events/antimalware/{eventID}` | Get AntiMalware with specific event id. | `GET`
`/rest/events/appcontrol` | Get Application Control events. | `GET`
`/rest/events/appcontrol/{eventID}` | Get the Application Control event with the specified event ID. | `GET`
`/rest/events/integrity` | Get Integrity events. | `GET`
`/rest/events/integrity/{eventID}` | Get the Integrity event with the specified event ID. | `GET`
`/rest/events/logInspection` | Get log inspection events. | `GET`
`/rest/events/logInspection/{eventID}` | Get the Log Inspection event with the specified event ID. | `GET`
`/rest/events/webreputation` | Get Web Reputation events | `GET`
`/rest/events/webreputation/{eventID}` | 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` | List the Components of the host. | `GET`
`/rest/hosts/{hostID}/intrusion-prevention/ssl-configurations` | List SSL configurations. | `POST`, `GET`
`/rest/hosts/{hostID}/intrusion-prevention/ssl-configurations/{id}` | Get details of an SSL configuration. | `GET`, `POST`, `DELETE`
`/rest/hosts/{hostID}/trusted-update-mode` | Get the settings for trusted update mode on a host. | `POST`, `GET`
`/rest/hosts/{hostID}/virusPatterns` | List the Virus Pattern Components of the host. | `GET`
`/rest/identity-providers/saml` | List SAML identity providers. | `GET`, `POST`
`/rest/identity-providers/saml/{samlIdentityProviderID}` | Describe a SAML identity provider. | `GET`, `POST`, `DELETE`
`/rest/license/addActivationCode` | Adds the activation code for the specified module | `POST`
`/rest/license/listLicenseInfo` | List all the license information or based on the specified module name | `GET`
`/rest/license/retrieveActivationCode` | Retrieves the current activation code for the specified module | `GET`
`/rest/license/retrieveLicenseInfo` | Retrieves the current activation code for the specified module | `GET`
`/rest/manager-nodes` | List manager nodes. | `GET`
`/rest/manager-nodes/{managerNodeID}` | Describe a manager node. | `GET`, `POST`, `DELETE`
`/rest/managerInfo/components` | return detail component info in current system | `GET`
`/rest/managerInfo/featureSummary` | Get status summary of each protection feature | `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/newsfeed` | Get the meta data about the news feed | `GET`
`/rest/newsfeed/entries` | List the entries from the news feed. | `GET`
`/rest/newsfeed/entries/{entryID}` | Dismisses a news entry | `DELETE`
`/rest/policies/antimalware/scanConfigs` | Retrieve All AntiMalware Scan Configurations | `GET`, `POST`
`/rest/policies/antimalware/scanConfigs/{scanConfigID}` | Retrieve AntiMalware Scan Configurations by scan configuration ID | `GET`, `PUT`, `DELETE`
`/rest/policies/{policyID}/application-control` | Retrieve the application control settings for a policy. | `GET`, `POST`
`/rest/proxies` | List proxies. | `GET`, `POST`
`/rest/proxies/{proxyID}` | Describe a proxy. | `GET`, `POST`, `DELETE`
`/rest/reports` | List report templates. | `GET`
`/rest/rulesets` | Retrieve a list of rulesets. | `POST`, `GET`
`/rest/rulesets/{rulesetID}` | Gets the contents of one ruleset. | `GET`, `DELETE`
`/rest/scripts` | List scripts. | `GET`
`/rest/service-provider/saml` | Describe the SAML service provider. | `GET`, `POST`
`/rest/session` | Describe a session. | `GET`, `DELETE`, `POST`
`/rest/smart-folders` | Returns a list of all Smart Folders. | `POST`, `GET`
`/rest/smart-folders/{smartFolderID}` | Gets the details of one smart folder. | `POST`, `GET`, `DELETE`
`/rest/smart-folders/{smartFolderID}/synchronize` | Synchronizes a smart folder. | `POST`
`/rest/software-inventory` | Retrieve the list of all inventory metadata. | `POST`, `GET`
`/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. | `POST`
`/rest/software-inventory/drift/occurrences/{changeID}` | Gets computer and file details for the provided inventory change. | `GET`
`/rest/software-inventory/drift/occurrences/{changeID}/action` | Performs an allow or block action on one inventory change. | `POST`
`/rest/software-inventory/{inventoryID}` | Retrieve inventory list metadata. | `GET`, `DELETE`
`/rest/software-inventory/{inventoryID}/details` | 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` | Retrieve the manager diagnostics package. | `GET`
`/rest/suspicious-objects` | Update the suspicious objects list. | `POST`, `DELETE`
`/rest/syslog-configurations` | List syslog configurations. | `POST`, `GET`
`/rest/syslog-configurations/{syslogConfigurationID}` | Get syslog configuration details. | `GET`, `POST`, `DELETE`
`/rest/tasks/event-based` | List event-based tasks. | `POST`, `GET`
`/rest/tasks/event-based/{id}` | Delete an event-based task. | `DELETE`
`/rest/tasks/scheduled` | List scheduled tasks. | `GET`, `POST`
`/rest/tasks/scheduled/{scheduledTaskID}` | Describe a scheduled task. | `GET`, `POST`, `DELETE`
`/rest/tasks/scheduled/{scheduledTaskID}/recipients/administrators` | Modify a scheduled task's recipients list to add administrators. | `PUT`, `POST`
`/rest/tasks/scheduled/{scheduledTaskID}/recipients/administrators/{administratorID}` | Remove an administrator from a scheduled task's recipients list. | `DELETE`
`/rest/tasks/scheduled/{scheduledTaskID}/recipients/contacts` | Modify a scheduled task's recipients list with additional contacts. | `PUT`, `POST`
`/rest/tasks/scheduled/{scheduledTaskID}/recipients/contacts/{contactID}` | Remove a contact from a scheduled task's recipients list | `DELETE`
`/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/tenants/state/{state}` | Get tenants by tenant state | `GET`
`/rest/tenanttemplate` | Retrieve the current tenant template. | `GET`, `POST`

Copyright © 2017 Trend Micro Inc. All Rights Reserved.