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

/Client/{clientId}/Retire

client

Retires the client.

 

DELETE

/ClientGroup/{clientGroupId}

client computer group

Deletes the client computer group.

 

DELETE

/CommCell/DomainController/{domainId}

domain

Deletes the domain.

 

DELETE

/CommCell/KeyManagementServers

key management server

Deletes the key management server.

 

DELETE

/contentstore/file/{fileOrfolderId}

ContentStore

Deletes the file or folder in a ContentStore.

 

DELETE

/Instance/{instanceId}

instance

Deletes the instance.

 

DELETE

/Organization/{organizationId}

company

Deletes the company.

 

DELETE

/OperationWindow/{ruleId}

operation rule

Deletes the operation rule.

 

DELETE

/Plan/{planId}?confirmDelete={confirmDelete}

plan

Deletes the plan.

 

DELETE

/Role

role

Deletes the role.

 

DELETE

/SchedulePolicy/{taskId}

schedule policy

Deletes the schedule policy.

 

DELETE

/Sessions

user

Logs the user off.

 

DELETE

/Subclient/{subclientId}

subclient

Deletes the subclient.

 

DELETE

/SubclientPolicies/{subclientPolicyId}

subclient policy

Deletes the subclient policy.

 

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}?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

/V2/StoragePolicy/{STORAGEPOLICYID}

storage policy

Deletes the storage policy.

 

DELETE

/V2/StoragePolicy/{STORAGEPOLICYID}/Copy/{COPYID}

storage policy copy

Deletes the storage policy copy.

 

DELETE

/Workflow/{workflowId}

workflow

Deletes the workflow.

 

GET

/Agent?clientId={clientId}

agent

Lists all agents for the client.

 

GET

/Alert?pageNo={pageNo}&pageCount={pageCount}

alert

Lists all 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}/License

client

Lists the licenses that are applied to a client.

 

GET

/Client/{clientID}/Hierarchy?backedUp={value}

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/{clientId}/SQL/Instance/{instanceId}/ReferenceTimeForPITRestore/{PointInTimeVal}?Database={database}

client

Lists a backup job based on a point in time (PIT) value.

 

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/DomainController

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

/CommCell/KeyManagementServers/{keyProviderId}?propertyLevel={propertyLevel}&providerType={providerType}

key management server

Returns the details of a key management server.

 

GET

/Commcell/InternetOptions/Proxy

HTTP proxy server

Lists the details associated with an HTTP proxy server.

 

GET

/CommServ/AuditTrail

CommServe

Lists the audit trail settings.

 

GET

/Commcell/DRBackup/Options

CommServe

Returns Disaster Recovery (DR) Backup options.

 

GET

/CommServ/CustomCalendar

CommServe

Lists all custom calendars.

 

GET

/CommServ/MetricsReporting

CommServe

Returns the configuration for Cloud Metrics Reporting.

 

GET

/CommServ/WebServerConfiguration

web server

Returns the configuration for the web 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

/dcube/search/{datasourceID}/export?q={q}&sort={SortField SortStyle}&fl={CommaSeparatedFields}

data source

Returns the data stored in a data source.

 

GET

/DDBInformation/{ddbStoreId}

deduplication database

Returns the details of a deduplication database (DDB) and its partitions.

 

GET

/DRGroups/{DRGroupId}/Schedules?drType={DRTYPE}

schedule

Lists the schedules associated with a Disaster Recovery (DR) orchestration group.

 

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

/Email/message?docId={docId}&appId={appId}&clId={clientId}

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

/EmailServer

email server

Lists the email server configuration options.

 

GET

/Events

event

Lists CommCell events.

 

GET

/Exchange/DAG/{clientId}/RecoveryPoints?instanceId={instanceId}&backupsetId={backupsetId}&subclientId={subclientId}&appId={appId}

client

Lists recovery points for an Exchange DAG client.

 

GET

/instance/{instanceId}

instance

Lists the instance properties.

 

GET

/instance?clientId={clientId}

instance

Lists all instances for the client.

 

GET

/Job?clientId={clientId}&completedJobLookupTime={completedJobLookupTime}&jobCategory={jobCategory}&jobFilter={jobFilter}

job

Lists jobs.

 

GET

/Job/{jobId}/AdvancedDetails?infoType={infoType}

job

Returns the details for a specific job.

 

GET

/logmonitoring/Syslog/Status

Syslog server

Returns the details of the Syslog server.

 

GET

/MediaAgent

MediaAgent

Lists the MediaAgents.

 

GET

/NavigationSettings

user

Lists the Command Center navigation preferences.

 

GET

/Organization

company

Lists companies.

 

GET

/Organization/{organizationId}

company

List the company properties.

 

GET

/Organization/{organizationId}/EmailCustomization

company

Lists the email message header and footer configured for the company.

 

GET

/OperationWindow/OpWindowList?commcellId={commcellId}&clientId={clientId}&clientgroupId={clientgroupId}&appTypeId={appTypeId}&instanceId={instanceId}&backupsetId={backupsetId}&subclientId={subclientId}

operation rule

Lists the operation rules.

 

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

/Security/{EntityType}/{EntityId}/Permissions?parentEntityType={parentEntityType}&parentEntityId={parentEntityId}&includeAllPermission={includeAllPermission}

entity

Lists the permissions that the logged on user has on an entity.

 

GET

/Session?userId={userId}

user

Lists the user session details.

 

GET

/SharePoint/Pseudo/MemberServers

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?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

/SubclientPolicies

subclient policy

Lists all subclient policies.

 

GET

/SubclientPolicies/{subClientPolicyId}

subclient policy

Lists the subclient policy properties.

 

GET

/User?level={level}

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

/User/Apps

user

Lists the Web Console applications and features that a user has access to.

 

GET

/UserGroup

user group

Lists all user groups.

 

GET

/UserGroup/{userGroupId}

user group

Lists the user group properties.

 

GET

/UsersAndGroups

user and user group

Lists all users and user groups.

 

GET

/V2/StoragePolicy

storage policy

Lists all storage policies.

 

GET

/V2/StoragePolicy/{STORAGEPOLICYID}?propertyLevel={PROPERTYLEVEL}

storage policy

Returns the details of a storage policy

 

GET

/V2/StoragePolicy/{STORAGEPOLICYID}/SearchEngineProperties

storage policy

Returns the list of search engines associated with a storage policy.

 

GET

/V2/StoragePolicy/{STORAGEPOLICYID}/Copy/{COPYID}

storage policy copy

Returns the details of a storage policy copy.

 

GET

/V2/StoragePolicy/{STORAGEPOLICYID}/Copy/{COPYID}/Size

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

/VSAclientlist

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.

 

GET

/Workflow/{workflowID}/definition

workflow

Returns the workflow definition, such as the inputs, activities, and transitions.

 

POST

/Agent + request body

agent

Updates the agent properties.

update_agent_template.xml, update_agent_template.json

POST

/Alert/{livefeedId} + request body

alert

Updates the status of a console alert.

update_console_alert_status.xml

POST

/AlertRule + request body

alert

Creates an alert.

create_alert.xml,create_alert.json

POST

/AlertRule/{ruleId}/Action/Modify + request body

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

/Client/License/Reconfigure + request body

client

Reapplies a license to a CommCell entity

reconfigure_license_template.xmlreconfigure_license_template.json

POST

/Client/License/Release + request body

client

Releases a license from a client or an agent.

release_license_template.xml, release_license_template.json

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/DomainController + request body

domain

Updates the domain.

update_domain.xml, update_domain.json

POST

/CommCell/KeyManagementServers

key management server

Creates a key management server.

create_key_management_server_template.xml, create_key_management_server_template.json

POST

/Commcell/InternetOptions/Proxy + request body

HTTP proxy server

Creates an HTTP proxy server.

create_http_proxy_server_template.xml

POST

/CommServ/AuditTrail + request body

CommServe

Updates the audit trail retention settings.

update_audit_trail_template.xml, update_audit_trail.json

POST

/CommServ/CustomCalendar + request body

CommServe

Creates a custom calendar.

create_custom_calendar_template.xml

POST

/CommServ/DRBackup

CommServe

Runs a disaster recovery backup job.

See REST API - POST Disaster Recovery Backup.

POST

/Commcell/DRBackup/Options

CommServe

Modifies Disaster Recovery (DR) Backup options.

update_disaster_recovery_backup_options_template.xml

POST

/CommServ/GlobalParams + request body

CommServe

Returns the values for global parameters.

get_global_param_values.xml

POST

/CommServ/MetricsReporting + request body

CommServe

Updates the configuration for Cloud Metrics Reporting.

update_cloud_metrics_reporting_template.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

/Email/Search + request body

email messages

Returns a list of email messages.

search_emails.xml

POST

/EmailServer + request body

email server

Updates the email server configuration options.

update_email_server_template.xml, update_email_server_template.json

POST

/ExecuteQCommand + request body

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

/Library + request body

library

Creates a cloud library.

create_cloud_library_template.xml, create_cloud_library_template.json

POST

/Login + request body

user

Retrieves an authentication token.

See Authentication: POST Login.

POST

/logmonitoring/Syslog/Config

Syslog server

Creates a Syslog server

create_syslog_server_template.xml

POST

/Logout

user

Ends the current session.

 

POST

/NavigationSettings?Organization={Organization}

company

Updates the Command Center navigation preferences.

update_navigation_template.xml, update_navigation_template.json

POST

/Organization + request body

company

Creates a company.

create_organization_template.json

POST

/organization/{organizationId}/action/activate

company

Activates a company.

 

POST

/organization/{organizationId}/action/deactivate + request body

company

Deactivates a company.

deactivate_organization_template.xml

POST

/OperationWindow + request body

operation rule

Creates an operation rule.

create_operation_rule_template.xml, create_operation_rule_template.json

POST

/QCommand/<qcommand> <applicable parameters>

QCommand

Sends a QCommand as a request.

An XML template is needed for operation execute QCommands.

POST

/QCommand + request body

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

/Schedules/task/Action/Enable

schedule

Enables the schedule or schedule policy.

 

POST

/Schedules/task/Action/Disable

schedule

Disables the schedule or schedule policy.

 

POST

/Security +request body

security association

Updates the security associations for an entity.

update_entity_security_template.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 + request body

schedule policy

Creates a schedule policy.

create_schedule_policy.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

/User/Validate + request body

user

Validates the user.

validate_user_template.xml

POST

/V2/StoragePolicy

storage policy

Creates a storage policy.

SP_creation.xml, SP_creation.json.

POST

/V2/StoragePolicy/{STORAGEPOLICYID}/Copy

storage policy copy

Creates a storage policy copy.

create_storage_policy_copy.xml, create_storage_policy_copy.json

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

/CommCell/KeyManagementServers

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

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

/Organization/{OrganizationId}/EmailCustomization + request body

company

Updates the email message header and footer configured for the company.

{
"footerTemplate":"footer text",
"headerTemplate":"header text"
}

PUT

/OperationWindow + request body

operation rule

Updates an operation rule.

update_operation_rule_template.xml, update_operation_rule_template.json

PUT

/Plan/{planId}/sla + request body

plan

Updates the SLA (service level agreement) for a plan.

put_plan_sla_template.xml, put_plan_sla_template.json

PUT

/Subclient/{subclientId}/content + request body

subclient

Updates subclient content for virtual machines.

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

PUT

/Task + request body

schedule policy

Updates a schedule policy.

update_schedule_policy.xml

PUT

/V2/StoragePolicy/{STORAGEPOLICYID}

storage policy

Updates a storage policy.

XML_updateSP.xml, XML_updateSP.json

PUT

/V2/StoragePolicy/{STORAGEPOLICYID}/Copy/{COPYID}

storage policy copy

Updates a storage policy copy.

UpdateCopy.xml, UpdateCopy.json

PUT

/workflow + request body

workflow

Imports a workflow definition.

An XML or JSON file containing the workflow definition

Last modified: 8/28/2020 5:30:05 PM