When to use the legacy REST API
You should continue to use the legacy REST API if it provides the capabilities that you need and those capabilities are not yet provided in the Deep Security API. The following table summarizes the availability of REST API capabilities in the Deep Security API.
Note:
Endpoints are continuously being added to the Deep Security API. Periodically check this table for changes.
| Category | Capability | Deep Security API support |
|---|---|---|
| Authentication | Log in and log out | Yes - API keys |
| Log into a tenant account (not available on Deep Security as a Service) | Yes - API keys (not available for Deep Security as a Service) | |
| Describe and end a session | Not available | |
| Administrators | Create, describe, list, modify, and delete an administrator | Yes - See Administrators in the API Reference |
| Policy settings | Describe, modify, and delete the Anti-Malware settings of a policy | Yes - See Modify a Policy in the API Reference |
| Reset, describe, and modify the scanner settings of a policy | Not available | |
| Describe and modify the Application Control settings of a policy | Yes - See Modify a Policy in the API Reference | |
| Hosts (Computers) | Describe, modify, and delete the Anti-Malware settings of a computer | Yes - See Modify a Computer in the API Reference |
| Reset, describe, and modify the scanner settings of a computer | Not available | |
| Create, delete, describe, list, modify, and synchronize a smart folder | Not available | |
| List the computers in a smart folder | Not available | |
| List, disable, describe, and modify relays and relay groups | Not available | |
| List the tree of host groups | Yes - See List Computer Groups in the API Reference | |
| Describe, modify, and delete scanner settings on a computer | Not available | |
| Manager nodes | List, delete, describe, and modify Deep Security Manager nodes (not available for Deep Security as a Service) | Not available |
| Tenants | Create, describe, delete, modify, and list tenants (not available for Deep Security as a Service) | Yes - See the Tenants operations in the API Reference (not available for Deep Security as a Service) |
| Describe and create tenant templates (not available for Deep Security as a Service) | Not available | |
| Malware scan configurations | Create, describe, list, modify, and delete a malware scan configuration | Yes - See Anti-Malware Configurations in the API Reference |
| Scheduled Tasks | Create, delete, describe, modify, and list scheduled tasks | Yes - See Scheduled Tasks in the API Reference |
| Modify a scheduled task recipient list | Yes - See Scheduled Tasks > Modify a Scheduled Task > Request Body > generateReportTaskParameters in the API Reference | |
| Scripts | List scripts | Yes - See Scripts in the API Reference |
| Reports | List report templates | Yes - See Report Templates in the API Reference |
| Alerts | Describe and list alerts | Not available |
| Describe, list, modify, and reset alert types | Not available | |
| Dismiss an alert, and dismiss an alert on a single target | Not available | |
| Event-based tasks | Create, delete, and list event-based tasks | Yes - See Event Based Tasks in the API Reference |
| Roles | Add, delete, and modify a role's host, host group, and policy access | Not available |
| Add and delete a role right | Not available | |
| Create, delete, describe, modify, and list roles | Not available | |
| Billing | List AWS Marketplace billing records and instance rates (Deep Security as a Service only) | Not available |
| List AWS MMS usage details and usage summary (AWS Marketplace only) | Not available | |
| Cloud | Connect to an AWS account, delete, modify, and describe the connection | Not available |
| List, create, delete, describe, modify, and sync cloud accounts (non-AWS) | Not available | |
| Application Control | Describe, list, and undo a decision log | Not available |
| Create, delete, describe, and list rulesets | Not available | |
| Describe a global ruleset, and add and delete global ruleset rules | Not available | |
| Describe, list, and review application drift and computer drift | Not available | |
| Create, delete, describe, and list software inventories | Not available | |
| Describe and modify Trusted Update Mode (Maintenance Mode) | Not available | |
| Intrusion Prevention | Create, delete, modify, describe, and list SSL configurations | Not available |
| Connected Threat Defense | Clear and modify the list of suspicious objects | Not available |
| Events | List and describe Anti-Malware, Integrity Monitoring, Log Inspection, Web Reputation, and Application Control events | Not available |
| List, create, delete, describe, and modify Syslog configurations | Not available | |
| SAML | Describe a SAML service provider | Not available |
| Modify a SAML service provider (not available for Deep Security as a Service) | Not available | |
| List, create, delete, describe, and modify SAML identity providers | Not available | |
| Assume a role using SAML | Not available | |
| Diagnostics | Get manager and agent diagnostic packages | Not available |
| Licenses | Describe license statuses and update activation codes | Not available |
| News Feed | Describe, list, and dismiss news feed items | Not available |
| Environment | List, create, delete, describe, and modify a proxy | Not available |
| Performance profiles | List, create, delete, describe, and modify profile configurations (not available for Deep Security as a Service) | Not available |
