REST API - API Library

 Updated Wednesday, November 29, 2023

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 Deletes the

computer client
group computer
group.

DELETE /CommCell/DomainController/{domainId} domain Deletes the

domain.

DELETE /CommCell/KeyManagementServers key Deletes the

management key
server 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 Deletes the

rule operation rule.

DELETE /Plan/{planId}?confirmDelete={confirmDelete} plan Deletes the

plan.

DELETE /Role role Deletes the

role.

DELETE /SchedulePolicy/{taskId} schedule Deletes the

policy schedule
policy.

DELETE /Sessions user Logs the user

off.

DELETE /Subclient/{subclientId} subclient Deletes the

subclient.

DELETE /SubclientPolicies/{subclientPolicyId} subclient Deletes the

policy subclient
policy.
DELETE /Task/{taskId}/Agent schedule Removes the
policy agent type or
agent group
association
from the
schedule
policy.

DELETE /Task/{taskId}/Entity schedule Removes an

policy 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 Deletes the

policy storage policy.

DELETE /V2/StoragePolicy/{STORAGEPOLICYID}/Copy/{COPYID} storage Deletes the

policy copy 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 /AnalyticsServers/indexserverclient/{indexserverClientId client Lists all index

servers 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= client Browses

{toTime} Microsoft SQL
Server
instances that
were backed
up.

GET /Client/{clientId}/SQL/Instance/{instanceId}/ReferenceTimeForPITRestore/{PointInTimeVal}? client Lists a backup

Database={database} 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 /GetId?clientname={clientName} client Returns the ID

for a client.

GET /ClientGroup client Lists all client

computer computer
group groups.

GET /ClientGroup/{clientGroupId} client Lists the client

computer computer
group group
properties.

GET /CommCell/DomainController domain Lists the

domains
registered
with the
CommServe
computer.
GET /CommCell/KeyManagementServers?propertyLevel={propertyLevel}&providerType= key List all key
{providerType} management management
server servers.

GET /CommCell/KeyManagementServers/{keyProviderId}?propertyLevel= key Returns the

{propertyLevel}&providerType={providerType} management details of a
server key
management
server.

GET /Commcell/InternetOptions/Proxy HTTP proxy Lists the

server 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 Lists the

database registered
CommServe
databases.

GET /dcube/search/{datasourceID}/export?q={q}&sort={SortField SortStyle}&fl= data source Returns the

{CommaSeparatedFields} data stored in
a data source.

GET /DDBInformation/{ddbStoreId} deduplication Returns the

database 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 Returns the

messages metadata for
an email
message.

GET /Email/message/Preview?docId={docId}&appId={appId}&guid={guid} email Returns the

messages 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= client Lists recovery

{backupsetId}&subclientId={subclientId}&appId={appId} points for an
Exchange
DAG client.

GET /IndexServers?cloudId={cloudId}&cloudType={cloudType}&roleIds={roleIds}&roleOp= client Returns a list

{roleOp}&permissionId={permissionId} of index
servers.

GET /instance/{instanceId} instance Lists the

instance
properties.

GET /instance?clientId={clientId} instance Lists all

instances for
the client.

GET /Job?clientId={clientId}&completedJobLookupTime= job Lists jobs.

{completedJobLookupTime}&jobCategory={jobCategory}&jobFilter={jobFilter}

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= operation Lists the

{clientId}&clientgroupId={clientgroupId}&appTypeId={appTypeId}&instanceId= rule operation
{instanceId}&backupsetId={backupsetId}&subclientId={subclientId} rules.

GET /Plan plan Lists all plans.

GET Plan/{planId}/AssociatedEntities 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 role Lists all roles.

GET /Role/{roleId} role Lists the role

properties.

GET /Schedules?clientId={clientId}&apptypeId={apptypeId}&instanceId= schedule Lists all

{instanceId}&backupsetId={backupsetId}&subclientId={subclientId} schedules.

GET /Schedules/{taskId} schedule Lists the

schedule
properties.

GET /SchedulePolicy schedule Lists all

policy schedule
policies.

GET /SchedulePolicy/{taskId} schedule Lists the

policy schedule
policy
properties.

GET /Security/{EntityType}/{EntityId}/Permissions?parentEntityType= entity Lists the

{parentEntityType}&parentEntityId={parentEntityId}&includeAllPermission= permissions
{includeAllPermission} 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 Lists all

policy 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= subclient Browses data

{showDeletedFiles}&vsFileBrowse={vsFileBrowse}&vsDiskBrowse={vsDiskBrowse} obtained
through a
backup.

GET /SubclientPolicies subclient Lists all

policy subclient
policies.

GET /SubclientPolicies/{subClientPolicyId} subclient Lists the

policy 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 Lists all users

group and user
groups.

GET /V2/StoragePolicy storage Lists all

policy storage
policies.

GET /V2/StoragePolicy/{STORAGEPOLICYID}?propertyLevel={PROPERTYLEVEL} storage Returns the

policy details of a
storage policy
GET /V2/StoragePolicy/{STORAGEPOLICYID}/SearchEngineProperties storage Returns the
policy list of search
engines
associated
with a storage
policy.

GET /V2/StoragePolicy/{STORAGEPOLICYID}/Copy/{COPYID} storage Returns the

policy copy details of a
storage policy
copy.

GET /V2/StoragePolicy/{STORAGEPOLICYID}/Copy/{COPYID}/Size storage Returns the

policy copy 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 update_agent_te

agent update_agent_te
properties.

POST /Alert/{livefeedId} + request body alert Updates the update_console_a

status of a
console alert.

POST /AlertRule + request body alert Creates an create_alert.xml,c

alert.

POST /AlertRule/{ruleId}/Action/Modify + request body alert Updates the modify_alert.xml,

alert.

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 create_backup_s

backup set. create_backup_s

POST /Backupset/{backupsetId} + request body backup set Updates the update_backupse

backup set update_backupse
properties.

POST /Client + request body client Creates a create_hyperv_te

virtualization
client.

POST /Client/{clientID} + request body client Updates the update_client_tem

client
properties.

POST /Client/License/Reconfigure + request body client Reapplies a reconfigure_licen

license to a reconfigure_licen
CommCell
entity

POST /Client/License/Release + request body client Releases a release_license_te

license from a release_license_te
client or an
agent.

POST /ClientGroup/{clientGroupId} + request body client Updates the update_client_co

computer client
group computer
group
properties.

POST /ClientGroup + request body client Creates a create_client_com

computer client
group computer
group.

POST /CommCell/DomainController + request body domain Updates the update_domain.x

domain.

POST /CommCell/KeyManagementServers key Creates a key create_key_mana

management management create_key_mana
server server.

POST /Commcell/InternetOptions/Proxy + request body HTTP proxy Creates an create_http_prox

server HTTP proxy
server.

POST /CommServ/AuditTrail + request body CommServe Updates the update_audit_tra

audit trail
retention
settings.

POST /CommServ/CustomCalendar + request body CommServe Creates a create_custom_c

custom
calendar.

POST /CommServ/DRBackup CommServe Runs a See REST API - PO

disaster
recovery
backup job.
POST /Commcell/DRBackup/Options CommServe Modifies update_disaster_
Disaster
Recovery (DR)
Backup
options.

POST /CommServ/GlobalParams + request body CommServe Returns the get_global_param

values for
global
parameters.

POST /CommServ/MetricsReporting + request body CommServe Updates the update_cloud_me

configuration
for Cloud
Metrics
Reporting.

POST /contentstore/file/{folderId} ContentStore Creates a new <App_FileResourc

folder in the
ContentStore.

POST /CreateTask + request body backup set or Runs a create_task_temp

subclient backup job on
the subclient
or the backup
set.

POST /CreateTask + request body backup Restores create_task_temp

virtual server
data obtained
through a
backup.

POST /DoBrowse + request body backup Browses data browse_template

obtained
through a
backup.

POST /Email/Search + request body email Returns a list search_emails.xm

messages of email
messages.

POST /EmailServer + request body email server Updates the update_email_ser

email server update_email_ser
configuration
options.

POST /ExecuteQCommand + request body QCommand Sends a Send the QComm

QCommand request body.
as a request.

POST /InstallClient + request body client Installs a new install_client_tem

client or
associate
entities to an
existing client.

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 create_disk_libra
library.

POST /Library + request body library Creates a create_cloud_libr

cloud library. create_cloud_libr

POST /Login + request body user Retrieves an See Authenticatio

authentication
token.

POST /logmonitoring/Syslog/Config Syslog server Creates a create_syslog_ser

Syslog server

POST /Logout user Ends the

current
session.

POST /NavigationSettings?Organization={Organization} company Updates the update_navigatio

Command update_navigatio
Center
navigation
preferences.

POST /Organization + request body company Creates a create_organizat

company.

POST /organization/{organizationId}/action/activate company Activates a

company.

POST /organization/{organizationId}/action/deactivate + request body company Deactivates a deactivate_organ

company.

POST /OperationWindow + request body operation Creates an create_operation

rule operation rule. create_operation

POST /QCommand/<qcommand> <applicable parameters> QCommand Sends a An XML template

QCommand QCommands.
as a request.

POST /QCommand + request body QCommand Sends a Send the QComm

QCommand body.
as a request.

POST /retrieveToClient + request body backup Restores data retrievetoclient_t

obtained retrievetoclient_t
through a
backup.

POST /Role + request body role Creates a role. create_role_temp

POST /Role/{roleId} + request body role Updates the update_role_temp

role
properties.

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 Updates the update_entity_se

association security
associations
for an entity.
POST /Subclient/{subclientId} + request body subclient Updates the update_subclient
subclient update_subclient
properties. update_subclient

POST /Subclient/{subclientId}/action/backup?backupLevel= subclient Runs a

{backupLevel}&runIncrementalBackup={runIncrementalBackup}&incrementalLevel= backup job on
{incrementalLevel} the subclient.

POST /Subclient + request body subclient Creates a create_subclient_

subclient. create_subclient_

POST /Task + request body schedule Creates a create_schedule_

policy schedule
policy.

POST /Task/{taskId}/Agent/add schedule Adds an agent

policy or agent
group to the
schedule
policy.

POST /Task/{taskId}/Entity/add schedule Associates an

policy entity, such as
client group,
client, agent,
instance,
backup set, or
subclient to a
schedule
policy.

POST /Task/{taskId}/Entity/exclude schedule Excludes a

policy particular
entity, such as
client, agent,
instance,
backup set, or
subclient from
a schedule
policy.

POST /Task/{taskId}/SubTask/{subTaskId} schedule Modifies the

policy schedule
pattern for a
schedule
policy.

POST /User + request body user Creates a create_user_temp

user.

POST /User/{userId} + request body user Updates the modify_user_tem

user
properties.

POST /User/AccountManagement + request body user Updates the update_user_cred

credentials for
a user
account

POST /User/Validate + request body user Validates the validate_user_tem

user.

POST /UserGroup + request body user group Creates a user create_usergroup

group.

POST /UserGroup/{userGroupId} + request body user group Updates the modify_usergroup

user group
properties.
POST /V2/StoragePolicy storage Creates a SP_creation.xml, S
policy storage policy.

POST /V2/StoragePolicy/{STORAGEPOLICYID}/Copy storage Creates a create_storage_p

policy copy storage policy create_storage_p
copy.

POST /wapi/{workflowName} workflow Executes a <inputs><INPUTN>

workflow as an
API.

POST /Workflow/{workflowId}/Action/Execute + request body workflow Executes a execute_workflow

workflow as a execute_workflow
job.

PUT /CommCell/KeyManagementServers key Updates the modify_key_mana

management properties of a modify_key_mana
server key
management
server.

PUT /ContentStore ContentStore Create a

ContentStore
for the specific
user.

PUT /contentstore/file/{fileOrfolderId}/action/move ContentStore Moves a file or <App_FileResourc

folder to
another folder
within the
ContentStore.

PUT /contentstore/file/{fileOrfolderId}/action/rename ContentStore Renames a file <App_FileResourc

or folder in the
ContentStore.

PUT /Organization/{OrganizationId}/EmailCustomization + request body company Updates the {

email "footerTemplate":
message "headerTemplate
header and }
footer
configured for
the company.

PUT /OperationWindow + request body operation Updates an update_operation

rule operation rule. update_operation

PUT /Plan/{planId}/sla + request body plan Updates the put_plan_sla_tem

SLA (service
level
agreement)
for a plan.

PUT /Subclient/{subclientId}/content + request body subclient Updates put_subclient_vm

subclient
content for
virtual
machines.

PUT /Task + request body schedule Adds or update_schedule_

policy removes update_schedule_
agent
associations
on a schedule
policy.
PUT /Task + request body schedule Adds, update_schedule_
policy excludes, or update_schedule_
removes entity
associations
on a schedule
policy.

PUT /Task + request body schedule Updates a update_schedule_

policy schedule
policy.

PUT /V2/StoragePolicy/{STORAGEPOLICYID} storage Updates a XML_updateSP.xm

policy storage policy.

PUT /V2/StoragePolicy/{STORAGEPOLICYID}/Copy/{COPYID} storage Updates a UpdateCopy.xml,

policy copy storage policy
copy.

PUT /workflow + request body workflow Imports a An XML or JSON f

workflow
definition.