Question & Answer
Question
What are the REST API commands that can be used with the IBM Spectrum Protect V7.1.3 Operations Center? Tip: Beginning with Version 7.1.3, IBM® Tivoli® Storage Manager is now IBM Spectrum Protect™. Some applications such as the software fulfillment systems and IBM License Metric Tool use the new product name. However, the software and its product documentation continue to use the Tivoli Storage Manager product name. To learn more about the rebranding transition, see http://www.ibm.com/support/docview.wss?uid=swg21963634 .
Answer
Note: Some of the URLs were changed for Version 7.1.4. If you are using Version 7.1.4, see http://www.ibm.com/support/docview.wss?uid=swg21973011
All URLs start with https://{oc server url}:{port}/oc/api/
GET Service
Description | URL |
Help | help |
Servers | servers |
Server detail | server/{server name}/detail |
Clients | clients |
Client detail | server/{server name}/client/{client name}/detail |
Client at risk | server/{server name}/client/{client name}/atrisk |
Client filespaces | server/{server name}/client/{client name}/filespaces |
Client filespace detail | server/{server name}/client/{client name}/filespace/{filespace}/detail |
Domains | domains |
Domain detail | server/{server name}/domain/{domain name}/detail |
Domain management classes | server/{server name}/domain/{domain name}/mgmtclasses |
Domain management class detail | server/{server name}/domain/{domain name}/mgmtclass/{mgmtclass}/detail |
Schedules | schedules |
Schedule details | server/{server name}/domain/{domain name}/schedule/{schedule name}/detail |
Schedule assignees | server/{server name}/domain/{domain name}/schedule/{schedule name}/assignees |
Storage pools | storagepools |
Storage pool detail | server/{server name}/storagepool/{storage pool}/detail |
Storage devices | storagedevices |
Storage device detail | server/{server name}/storagedevice/{device name}/detail |
PUT Service
Description | URL | Body Parameter |
Update client password | server/{server name}/client/{client name}/password | { "password": "<new password>" } |
Lock client | server/{server name}/client/{client name}/lock | |
Unlock client | server/{server name}/client/{client name}/unlock | |
Assign a client to a new backup schedule | server/{server name}/client/{client name}/assignschedule | { "schedule": "<schedule name>" } |
Decommission client | server/{server name}/client/{client name}/decommissionclient | |
Decommission virtual machine | server/{server name}/client/{client name}/vm/{vm name}/decommissionclient |
POST Service
Description | URL | Body Parameter (All keys are required, but [ ] indicates optional value) |
Register node | server/{server name}/client | { "name":"<node name>", "authentication":"<authentication type>", "password":"<password>", "domain":"<domain name>", "contact":"<contact name>", "email":"<email>", "schedule":"[ <schedule name> ]", "optionset":"[ <optionset name> ]", "deduplication":"[ <deduplication> ]", "sslrequired":"[ <sslrequired> ]", "sessioninitiation":"[ <sessioninitiation> ]" } |
Issue command | cli/issueCommand | <tsm command> |
Issue confirm command | cli/issueConfirmed/Command | <tsm command> |
Was this topic helpful?
Document Information
Modified date:
17 June 2018
UID
swg21963573