V11 SP8
Loading...

REST API - API Library

The following is a table of all available REST APIs.

Method API Resource Description Request Template
DELETE /AlertRule/{alertId} alert Deletes the alert.  
DELETE /Backupset/{backupsetId} backup set Deletes the backup set.  
DELETE /Client/{clientId} client Deletes the client.  
DELETE /ClientGroup/{clientGroupId} client computer group Deletes the client computer group.  
DELETE /contentstore/file/{fileOrfolderId} ContentStore Deletes a file or folder in a ContentStore.  
DELETE /Role role Deletes the role.  
DELETE /Sessions user Logs the user off.  
DELETE /StoragePolicy/{spName} storage policy Deletes the storage policy.  
DELETE /Subclient/{subclientId} subclient Deletes the subclient.  
DELETE /Task/{taskId}/Agent schedule policy Removes the agent type or agent group association from the schedule policy.  
DELETE /Task/{taskId}/Entity schedule policy Removes an entity association, such as client group, client, agent, instance, backup set, or subclient from the schedule policy.  
DELETE /User/{userId} user Deletes the user.  
DELETE /UserGroup/{userGroupId} user group Deletes the user group.  
GET /Agent?clientId={clientId} agent Lists all agents for the client.  
GET /Alert?pageNo={pageNo}&pageCount={pageCount} alert Returns a list of console alerts.  
GET /AlertRule alert Lists all alerts.  
GET /AlertRule/{alertId} alert Lists the alert details.  
GET /Backupset/{backupsetId} backup set Lists the backup set properties.  
GET /Backupset?clientId={clientId} backup set Lists all backup sets for the client.  
GET /Client/{clientID} client Lists the client properties.  
GET /Client/{clientId}/AdditionalSettings client Lists the additional settings for the client.  
GET /Client/{clientID}/Hierarchy?backedUp={value} subclient Lists subclients that have backup jobs available to restore and the hierarchy above those subclients.  
GET /Client/proxy/CloudApps?cAppType={cAppType} client Lists all proxy clients for cloud apps virtual clients.  
GET /Client?PseudoClientType={CloudApps} client Lists all cloud apps virtual clients in a CommCell Console.  
GET /Client?PseudoClientType={VSPseudo} client Lists all clients.  
GET /Client/VMPseudoClient client Lists all virtualization clients.  
GET /ClientGroup client computer group Lists all client computer groups.  
GET /ClientGroup/{clientGroupId} client computer group Lists the client computer group properties.  
GET /Commcell/InternetOptions/Proxy HTTP proxy server Lists the details associated with an HTTP proxy server.  
GET /contentstore/file/{fileOrfolderID} ContentStore Lists the properties of the file or folder.  
GET /dcube/getcommcellinfo CommServe database Lists the registered CommServe databases.  
GET /drive/file/{fileId}/versions Edge Drive Returns the first 50 versions of a file in Edge Drive based on the GUID of the file.  
GET /drive/file/versions?path={path} Edge Drive Returns the first 50 versions of a file in Edge Drive based on the file path.  
GET /EmailServer email server Lists the email server configuration options.  
GET /Events event Lists CommCell events.  
GET /Job?clientId={clientId} job Lists all jobs for the client.  
GET /Job/{jobId} job Returns the summary for a specific job.  
GET /MediaAgent MediaAgent Lists the MediaAgents.  
GET /Plan plan Lists all plans.  
GET /Recall?at={appTypeId}&si={stubinfo}&op={path}&appId={subclientId}&ec={encoding} job Initiates a download of data obtained through a backup.  
GET /Role role Lists all roles.  
GET /Role/{roleId} role Lists the role properties.  
GET /Schedules?clientId={clientId}&apptypeId={apptypeId}&instanceId={instanceId}&backupsetId={backupsetId}&subclientId={subclientId} schedule Lists all schedules.  
GET /Schedules/{taskId} schedule Lists the schedule properties.  
GET /SchedulePolicy schedule policy Lists all schedule policies.  
GET /SchedulePolicy/{taskId} schedule policy Lists the schedule policy properties.  
GET /Session?userId={userId} user Lists the user session details.  
GET /StoragePolicy storage policy Lists all storage policies.  
GET /StoragePolicyListAssociatedToMediaAgent?MediaAgent={MediaAgent} storage policy Lists all storage policies associated with a MediaAgent.  
GET /Subclient?clientId={clientId} subclient Lists all subclients for the client.  
GET /Subclient/{subclientId} subclient Lists the subclient properties.  
GET /Subclient/{subclientId}/Browse?path={path}&showDeletedFiles={showDeletedFiles}&vsFileBrowse={vsFileBrowse}&vsDiskBrowse={vsDiskBrowse} subclient Browses data obtained through a backup.  
GET /UsersAndGroups user and user group Lists all users and user groups.  
GET /UserGroup user group Lists all user groups.  
GET /UserGroup/{userGroupId} user group Lists the user group properties.  
GET /User user Lists all users.  
GET /User/{userId} user Lists the user properties.  
GET /User/{userId}/preferences/{prefType}?includeAdditionalSettings=true user Lists the additional settings for the user.  
GET /VMBrowse?PseudoClientId={PseudoClientId}&inventoryPath={\type:name}&server={server} client Browses virtual machines.  
GET /VSAclientlist?userId={userId} client Lists the clients where the Virtual Server agent is installed.  
GET /VSBrowse/{pseudoClientId}/{entityName}?requestType={requestType} client Browses datastores.  
GET /wapi/{workflowName}?input={value}&input_n={value_n} workflow Executes a workflow as an API.  
GET /Workflow workflow Lists all workflows.  
POST /Agent + request body agent Updates the agent properties. update_agent_template.xml, update_agent_template.json
POST /AlertRule + request body alert Creates an alert. create_alert.xml, create_alert.json
POST /AlertRule/{ruleId}/Action/Modify alert Updates the alert. modify_alert.xml, modify_alert.json
POST /AlertRule/{alertId}/Action/Enable alert Enables the alert.  
POST /AlertRule/{alertId}/Action/Disable 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 /Backupset/{backupsetId}/action/backup backup set Runs a backup job on the backup set.  
POST /Backupset + request body backup set Creates a backup set. create_backup_set_template.xml, create_backup_set_template.json
POST /Backupset/{backupsetId} + request body backup set Updates the backup set properties. update_backupset_template.xml, update_backupset_template.json
POST /Client + request body client Creates a virtualization client. create_hyperv_template.xml, create_vmw_template.xml
POST /Client/{clientID} + request body client Updates the client properties. update_client_template.xml
POST /ClientGroup/{clientGroupId} + request body client computer group Updates the client computer group properties. update_client_computer_group_template.xml
POST /ClientGroup + request body client computer group Creates a client computer group. create_client_computer_group_template.xml
POST /Commcell/InternetOptions/Proxy + request body HTTP proxy server Creates an HTTP proxy server. create_http_proxy_server_template.xml
POST /CommServ/DRBackup CommServe Runs a disaster recovery backup job. See Syntax.
POST /CommServ/GlobalParams CommServe Returns the values for global parameters. get_global_param_values.xml
POST /contentstore/file/{folderId} ContentStore Creates a new folder in the ContentStore. <App_FileResourceInfo name=""/>
POST /CreateTask + request body backup set or subclient Runs a backup job on the subclient or the backup set. create_task_template_backup.xml
POST /CreateTask + request body backup Restores virtual server data obtained through a backup. create_task_template_restore.xml
POST /DoBrowse + request body backup Browses data obtained through a backup. browse_template.xml, browse_template.json
POST /EmailServer email server Updates the email server configuration options. update_email_server_template.xml, update_email_server_template.json
POST /ExecuteQCommand QCommand Sends a QCommand as a request. Send the QCommand, the parameters, and the XML in the request body.
POST /JobDetails + request body job Returns the details for a job.  
POST /Job/{jobId}/action/kill job Kills the job.  
POST /Job/{jobId}/action/resume job Resumes the job.  
POST /Job/{jobId}/action/pause job Suspends the job.  
POST /Library + request body library Creates a disk library. create_disk_library_template.xml
POST /Login + request body user Retrieves an authentication token. See Syntax.
POST /Logout user Ends the current session.  
POST /QCommand/<qcommand> <applicable parameters> QCommand Sends a QCommand as a request. An XML template is needed for operation execute QCommands.
POST /QCommand QCommand Sends a QCommand as a request. Send the QCommand and the parameters in the request body.
POST /retrieveToClient + request body backup Restores data obtained through a backup. retrievetoclient_template.xml, retrievetoclient_template.json
POST /Role + request body role Creates a role. create_role_template.xml, create_role_template.json
POST /Role/{roleId} + request body role Updates the role properties. update_role_template.xml, update_role_template.json
POST /StoragePolicy + request body storage policy Creates a storage policy. create_storage_policy.xml, create_storage_policy.json
POST /Subclient/{subclientId} + request body subclient Updates the subclient properties. update_subclient_template.xml, update_subclient_vm_template.xml, update_subclient_vm_template.json
POST /Subclient/{subclientId}/action/backup?backupLevel={backupLevel}&runIncrementalBackup={runIncrementalBackup}&incrementalLevel={incrementalLevel} subclient Runs a backup job on the subclient.  
POST /Subclient + request body subclient Creates a subclient. create_subclient_template.xml, create_subclient_vm_template.xml
POST /Task/{taskId}/Agent/add schedule policy Adds an agent or agent group to the schedule policy.  
POST /Task/{taskId}/Entity/add schedule policy Associates an entity, such as client group, client, agent, instance, backup set, or subclient to a schedule policy.  
POST /Task/{taskId}/Entity/exclude schedule policy Excludes a particular entity, such as client, agent, instance, backup set, or subclient from a schedule policy.  
POST /Task/{taskId}/SubTask/{subTaskId} schedule policy Modifies the schedule pattern for a schedule policy.  
POST /User + request body user Creates a user. create_user_template.xml
POST /User/{userId} + request body user Updates the user properties. modify_user_template.xml
POST /UserGroup + request body user group Creates a user group. create_usergroup_template.xml
POST /UserGroup/{userGroupId} + request body user group Updates the user group properties. modify_usergroup_template.xml
POST /wapi/{workflowName} workflow Executes a workflow as an API. <inputs><INPUTN>input_value</INPUTN></inputs>
POST /Workflow/{workflowId}/Action/Execute + request body workflow Executes a workflow as a job. execute_workflow_template.xml, execute_workflow_template.json
PUT /ContentStore ContentStore Create a ContentStore for the specific user.  
PUT /contentstore/file/{fileOrfolderId}/action/move ContentStore Moves a file or folder to another folder within the ContentStore. <App_FileResourceInfo parentGuid=""/>
PUT /contentstore/file/{fileOrfolderId}/action/rename ContentStore Renames a file or folder in the ContentStore. <App_FileResourceInfo name="" />
PUT /Plan/{planId}/sla plan Updates the SLA (service level agreement) for a plan. put_plan_sla_template.xml, put_plan_sla_template.json
PUT /StoragePolicy?storagepolicy={storagepolicy}&mediaagent={mediaagent}&library={library}&drivepool={drivepool}&scratchpool={scratchpool}&incstoragepolicy={incstoragepolicy}&deduppath={deduppath} storage policy Creates a storage policy.  
PUT /Subclient/{subclientId}/content + request body subclient Adds or updates subclient virtual machine content. put_subclient_vm_content.xml
PUT /Task + request body 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 /Task + request body 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