The following is a table of all available REST APIs.
Method | API | Resource | Description | Request Template |
|---|---|---|---|---|
DELETE | alert | Deletes the alert. |
| |
DELETE | backup set | Deletes the backup set. |
| |
DELETE | client | Deletes the client. |
| |
DELETE | client | Retires the client. | ||
DELETE | client computer group | Deletes the client computer group. |
| |
DELETE | domain | Deletes the domain. | ||
DELETE | key management server | Deletes the key management server. | ||
DELETE | ContentStore | Deletes the file or folder in a ContentStore. |
| |
DELETE | instance | Deletes the instance. | ||
DELETE | company | Deletes the company. | ||
DELETE | operation rule | Deletes the operation rule. |
| |
DELETE | plan | Deletes the plan. |
| |
DELETE | role | Deletes the role. |
| |
DELETE | schedule policy | Deletes the schedule policy. |
| |
DELETE | user | Logs the user off. |
| |
DELETE | subclient | Deletes the subclient. |
| |
DELETE | subclient policy | Deletes the subclient policy. | ||
DELETE | schedule policy | Removes the agent type or agent group association from the schedule policy. |
| |
DELETE | schedule policy | Removes an entity association, such as client group, client, agent, instance, backup set, or subclient from the schedule policy. |
| |
DELETE | /User/{userId}?newUserId={newUserId}&newUserGroupId={newUserGroupId} | user | Deletes the user and transfers the ownership of entities. |
|
DELETE | /UserGroup/{userGroupId}?newUserId={newUserId}&newUserGroupId={newUserGroupId} | user group | Deletes the user group and transfers the ownership of entities. |
|
DELETE | storage policy | Deletes the storage policy. |
| |
DELETE | storage policy copy | Deletes the storage policy copy. | ||
DELETE | workflow | Deletes the workflow. |
| |
GET | agent | Lists all agents for the client. |
| |
GET | alert | Lists all console alerts. |
| |
GET | alert | Lists all alerts. |
| |
GET | alert | Lists the alert details. |
| |
GET | backup set | Lists the backup set properties. |
| |
GET | backup set | Lists all backup sets for the client. |
| |
GET | client | Lists all index servers for the client | ||
GET | client | Lists the client properties. |
| |
GET | client | Lists the additional settings for the client. |
| |
GET | client | Lists the licenses that are applied to a client. |
| |
GET | client | Lists subclients that have backup jobs available to restore and the hierarchy above those subclients. |
| |
GET | /Client/{clientId}/SQL/Instance/{instanceId}/Browse?fromTime={fromTime}&toTime={toTime} | client | Browses Microsoft SQL Server instances that were backed up. |
|
GET | client | Lists a backup job based on a point in time (PIT) value. | ||
GET | client | Lists all proxy clients for cloud apps virtual clients. |
| |
GET | client | Lists all cloud apps virtual clients in a CommCell Console. |
| |
GET | client | Lists all clients. |
| |
GET | client | Lists all virtualization clients. |
| |
GET | client | Returns the ID for a client. | ||
GET | client computer group | Lists all client computer groups. |
| |
GET | client computer group | Lists the client computer group properties. |
| |
GET | domain | Lists the domains registered with the CommServe computer. | ||
GET | /CommCell/KeyManagementServers?propertyLevel={propertyLevel}&providerType={providerType} | key management server | List all key management servers. | |
GET | key management server | Returns the details of a key management server. | ||
GET | HTTP proxy server | Lists the details associated with an HTTP proxy server. |
| |
GET | CommServe | Lists the audit trail settings. | ||
GET | CommServe | Returns Disaster Recovery (DR) Backup options. | ||
GET | CommServe | Lists all custom calendars. |
| |
GET | CommServe | Returns the configuration for Cloud Metrics Reporting. |
| |
GET | web server | Returns the configuration for the web server. | ||
GET | ContentStore | Lists the properties of the file or folder. |
| |
GET | CommServe database | Lists the registered CommServe databases. |
| |
GET | /dcube/search/{datasourceID}/export?q={q}&sort={SortField SortStyle}&fl={CommaSeparatedFields} | data source | Returns the data stored in a data source. | |
GET | deduplication database | Returns the details of a deduplication database (DDB) and its partitions. | ||
GET | schedule | Lists the schedules associated with a Disaster Recovery (DR) orchestration group. | ||
GET | Edge Drive | Returns the first 50 versions of a file in Edge Drive based on the GUID of the file. |
| |
GET | Edge Drive | Returns the first 50 versions of a file in Edge Drive based on the file path. |
| |
GET | email messages | Returns the metadata for an email message. | ||
GET | /Email/message/Preview?docId={docId}&appId={appId}&guid={guid} | email messages | Returns the metadata and message body for an email message. | |
GET | email server | Lists the email server configuration options. |
| |
GET | event | Lists CommCell events. |
| |
GET | client | Lists recovery points for an Exchange DAG client. | ||
GET | instance | Lists the instance properties. |
| |
GET | instance | Lists all instances for the client. |
| |
GET | job | Lists jobs. |
| |
GET | job | Returns the details for a specific job. |
| |
GET | Syslog server | Returns the details of the Syslog server. | ||
GET | MediaAgent | Lists the MediaAgents. |
| |
GET | user | Lists the Command Center navigation preferences. | ||
GET | company | Lists companies. | ||
GET | company | List the company properties. | ||
GET | company | Lists the email message header and footer configured for the company. | ||
GET | operation rule | Lists the operation rules. |
| |
GET | plan | Lists all plans. |
| |
GET | plan | Lists the details of entities that are associated with a plan. | ||
GET | /Recall?at={appTypeId}&si={stubinfo}&op={path}&appId={subclientId}&ec={encoding} | job | Initiates a download of data obtained through a backup. |
|
GET | role | Lists all roles. |
| |
GET | role | Lists the role properties. |
| |
GET | schedule | Lists all schedules. |
| |
GET | schedule | Lists the schedule properties. |
| |
GET | schedule policy | Lists all schedule policies. |
| |
GET | schedule policy | Lists the schedule policy properties. |
| |
GET | entity | Lists the permissions that the logged on user has on an entity. | ||
GET | user | Lists the user session details. |
| |
GET | client | Returns a list of member servers for a SharePoint pseudo client. | ||
GET | /StoragePolicyListAssociatedToMediaAgent?MediaAgent={MediaAgent} | storage policy | Lists all storage policies associated with a MediaAgent. | |
GET | subclient | Lists all subclients for the client. |
| |
GET | subclient | Lists the subclient properties. |
| |
GET | subclient | Browses data obtained through a backup. |
| |
GET | subclient policy | Lists all subclient policies. | ||
GET | subclient policy | Lists the subclient policy properties. | ||
GET | user | Lists all users. |
| |
GET | user | Lists the user properties. |
| |
GET | /User/{userId}/preferences/{prefType}?includeAdditionalSettings=true | user | Lists the additional settings for the user. |
|
GET | user | Lists the Web Console applications and features that a user has access to. |
| |
GET | user group | Lists all user groups. |
| |
GET | user group | Lists the user group properties. |
| |
GET | user and user group | Lists all users and user groups. |
| |
GET | storage policy | Lists all storage policies. |
| |
GET | /V2/StoragePolicy/{STORAGEPOLICYID}?propertyLevel={PROPERTYLEVEL} | storage policy | Returns the details of a storage policy |
|
GET | storage policy | Returns the list of search engines associated with a storage policy. | ||
GET | storage policy copy | Returns the details of a storage policy copy. | ||
GET | storage policy copy | Returns the size of a storage policy copy. | ||
GET | /VMBrowse?PseudoClientId={PseudoClientId}&inventoryPath={\type:name}&server={server} | client | Browses virtual machines. |
|
GET | client | Lists the clients where the Virtual Server agent is installed. |
| |
GET | /VSBrowse/{pseudoClientId}/{entityName}?requestType={requestType} | client | Browses datastores. |
|
GET | workflow | Executes a workflow as an API. |
| |
GET | workflow | Lists all workflows. |
| |
GET | workflow | Returns the workflow definition, such as the inputs, activities, and transitions. | ||
POST | agent | Updates the agent properties. | ||
POST | alert | Updates the status of a console alert. | ||
POST | alert | Creates an alert. | ||
POST | alert | Updates the alert. | ||
POST | alert | Enables the alert. |
| |
POST | alert | Disables the alert. |
| |
POST | /AlertRule/{alertId}/notificationType/{notifTypeId}/Action/Enable | alert | Adds a notification type to an alert. |
|
POST | /AlertRule/{alertId}/notificationType/{notifTypeId}/Action/Disable | alert | Removes a notification type from an alert. |
|
POST | backup set | Runs a backup job on the backup set. |
| |
POST | backup set | Creates a backup set. | create_backup_set_template.xml, create_backup_set_template.json | |
POST | backup set | Updates the backup set properties. | update_backupset_template.xml, update_backupset_template.json | |
POST | client | Creates a virtualization client. | ||
POST | client | Updates the client properties. | ||
POST | client | Reapplies a license to a CommCell entity | reconfigure_license_template.xml, reconfigure_license_template.json | |
POST | client | Releases a license from a client or an agent. | ||
POST | client computer group | Updates the client computer group properties. | ||
POST | client computer group | Creates a client computer group. | ||
POST | domain | Updates the domain. | ||
POST | key management server | Creates a key management server. | create_key_management_server_template.xml, create_key_management_server_template.json | |
POST | HTTP proxy server | Creates an HTTP proxy server. | ||
POST | CommServe | Updates the audit trail retention settings. | ||
POST | CommServe | Creates a custom calendar. | ||
POST | CommServe | Runs a disaster recovery backup job. | ||
POST | CommServe | Modifies Disaster Recovery (DR) Backup options. | ||
POST | CommServe | Returns the values for global parameters. | ||
POST | CommServe | Updates the configuration for Cloud Metrics Reporting. | ||
POST | ContentStore | Creates a new folder in the ContentStore. | <App_FileResourceInfo name=""/> | |
POST | backup set or subclient | Runs a backup job on the subclient or the backup set. | ||
POST | backup | Restores virtual server data obtained through a backup. | ||
POST | backup | Browses data obtained through a backup. | ||
POST | email messages | Returns a list of email messages. | ||
POST | email server | Updates the email server configuration options. | update_email_server_template.xml, update_email_server_template.json | |
POST | QCommand | Sends a QCommand as a request. | Send the QCommand, the parameters, and the XML in the request body. | |
POST | client | Installs a new client or associate entities to an existing client. | ||
POST | job | Returns the details for a job. |
| |
POST | job | Kills the job. |
| |
POST | job | Resumes the job. |
| |
POST | job | Suspends the job. |
| |
POST | library | Creates a disk library. | ||
POST | library | Creates a cloud library. | create_cloud_library_template.xml, create_cloud_library_template.json | |
POST | user | Retrieves an authentication token. | ||
POST | Syslog server | Creates a Syslog server | ||
POST | user | Ends the current session. |
| |
POST | company | Updates the Command Center navigation preferences. | update_navigation_template.xml, update_navigation_template.json | |
POST | company | Creates a company. | ||
POST | company | Activates a company. | ||
POST | /organization/{organizationId}/action/deactivate + request body | company | Deactivates a company. | |
POST | operation rule | Creates an operation rule. | create_operation_rule_template.xml, create_operation_rule_template.json | |
POST | QCommand | Sends a QCommand as a request. | An XML template is needed for operation execute QCommands. | |
POST | QCommand | Sends a QCommand as a request. | Send the QCommand and the parameters in the request body. | |
POST | backup | Restores data obtained through a backup. | retrievetoclient_template.xml, retrievetoclient_template.json | |
POST | role | Creates a role. | ||
POST | role | Updates the role properties. | ||
POST | schedule | Enables the schedule or schedule policy. |
| |
POST | schedule | Disables the schedule or schedule policy. |
| |
POST | security association | Updates the security associations for an entity. | ||
POST | subclient | Updates the subclient properties. | update_subclient_template.xml, update_subclient_vm_template.xml, update_subclient_vm_template.json | |
POST | subclient | Runs a backup job on the subclient. |
| |
POST | subclient | Creates a subclient. | create_subclient_template.xml, create_subclient_vm_template.xml | |
POST | schedule policy | Creates a schedule policy. | ||
POST | schedule policy | Adds an agent or agent group to the schedule policy. |
| |
POST | schedule policy | Associates an entity, such as client group, client, agent, instance, backup set, or subclient to a schedule policy. |
| |
POST | schedule policy | Excludes a particular entity, such as client, agent, instance, backup set, or subclient from a schedule policy. |
| |
POST | schedule policy | Modifies the schedule pattern for a schedule policy. |
| |
POST | user | Creates a user. | ||
POST | user | Updates the user properties. | ||
POST | user | Updates the credentials for a user account | ||
POST | user | Validates the user. | ||
POST | user group | Creates a user group. | ||
POST | user group | Updates the user group properties. | ||
POST | storage policy | Creates a storage policy. | ||
POST | storage policy copy | Creates a storage policy copy. | create_storage_policy_copy.xml, create_storage_policy_copy.json | |
POST | workflow | Executes a workflow as an API. | <inputs><INPUTN>input_value</INPUTN></inputs> | |
POST | workflow | Executes a workflow as a job. | execute_workflow_template.xml, execute_workflow_template.json | |
PUT | key management server | Updates the properties of a key management server. | modify_key_management_server_template.xml, modify_key_management_server_template.json | |
PUT | ContentStore | Create a ContentStore for the specific user. |
| |
PUT | ContentStore | Moves a file or folder to another folder within the ContentStore. | <App_FileResourceInfo parentGuid=""/> | |
PUT | ContentStore | Renames a file or folder in the ContentStore. | <App_FileResourceInfo name="" /> | |
PUT | /Organization/{OrganizationId}/EmailCustomization + request body | company | Updates the email message header and footer configured for the company. | { |
PUT | operation rule | Updates an operation rule. | update_operation_rule_template.xml, update_operation_rule_template.json | |
PUT | plan | Updates the SLA (service level agreement) for a plan. | ||
PUT | subclient | Updates subclient content for virtual machines. | ||
PUT | schedule policy | Adds or removes agent associations on a schedule policy. | update_schedule_policy_agent_assoc_template.xml, update_schedule_policy_agent_assoc_template.json | |
PUT | schedule policy | Adds, excludes, or removes entity associations on a schedule policy. | update_schedule_policy_entity_assoc_template.xml, update_schedule_policy_entity_assoc_template.json | |
PUT | schedule policy | Updates a schedule policy. | ||
PUT | storage policy | Updates a storage policy. | ||
PUT | storage policy copy | Updates a storage policy copy. | ||
PUT | workflow | Imports a workflow definition. | An XML or JSON file containing the workflow definition |