IBM Spectrum Protect OC REST API Commands

GET Service

Description	URL
Help	help
Servers	servers
Server detail	servers/{server name}/details
Clients registered to server	servers/{server name}/clients
Schedules defined to server	servers/{server name}/schedules
Clients	clients
Client detail	servers/{server name}/clients/{client name}/details
Client at risk	servers/{server name}/clients/{client name}/atrisk
Client file spaces	servers/{server name}/clients/{client name}/filespaces
Client file space detail **	servers/{server name}/clients/{client name}/filespaces/{filespace}/details
Alerts	alerts
Client alerts	alerts/clients
Server alerts	alerts/server
Domains	domains
Domain detail	servers/{server name}/domains/{domain name}/details
Domain management classes	servers/{server name}/domains/{domain name}/mgmtclasses
Domain management class detail	servers/{server name}/domains/{domain name}/mgmtclasses/{mgmtclass}/details
Schedules	servers/{server}/domains/{domain}/clients/{client}/schedules
Schedule assignees	servers/{server name}/domains/{domain name}/schedules/{schedule name}/assignees
Storage pools	storagepools
Storage pool detail	servers/{server name}/storagepools/{storage pool}/details
Storage devices	storagedevices
Storage device detail	servers/{server name}/storagedevices/{device name}/details

PUT Service

Description	URL	Body Parameter
Update client	servers/{server name}/clients/{client name}	{ "updateClient":{ "password":"<password>", "schedule":{ "domain":"<domain>", "schedule":"<schedule>" }, "lock":"<yes/no>", "decommision":"<yes/no>" }
Decommission virtual machine	servers/{server name}/clients/{client name}/vms/{vm name}/decommissionclient

POST Service

Description	URL	Body Parameter ( [ ]  indicates optional key/value pair)
Register node	servers/{server name}/clients	{ "registerclient" : { "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[/{server name}]	<tsm command>
Issue confirm command*	cli/issueConfirmedCommand[/{server name}]	<tsm command>

Required headers

OC-API-Version: 1.0
Accept: [ application/json, application/xml ]

For PUT and POST

Content-Type: application/json, application/xml

For folowing URLs

cli/issueCommand
cli/issueCommand/{server name}
cli/issueConfirmedCommand
bcli/issueConfirmedCommand/{server name}

Content-Type: text/plain

Resource : IBM Support