This operation offboards a subclient based on the subclient ID.
Offboarding includes the following operations:
-
Remove the user as client owner for the client.
-
Disable backup on the subclient.
When you offboard a subclient, the plan settings do not change.
Request
Syntax
Send the request using either the ID or the name:
-
Name
POST <webservice>/Subclient/byName(clientName='{clientName}',appName='{ApplicationName}',instanceName='{instanceName}',backupsetName='{backupsetName}',subclientName='{subclientName}')/Offboard HTTP/1.1 Host: <host name> Accept: application/json Authtoken: <authentication token> Content-type: application/json -
ID
POST <webservice>/Subclient/{SubclientId}/Offboard HTTP/1.1 Host: <host name> Accept: application/json Authtoken: <authentication token> Content-type: application/json
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
|
Name |
Description |
Required |
|---|---|---|
|
subclientId |
The subclient ID for the subclient. If the subclient ID is not known, use the GET Subclient API to retrieve it. |
Yes-for the request by ID |
|
clientName |
The client name for the subclient. If the client name is not known, use the GET Subclient API to retrieve it. |
Yes-for the request by name |
|
appName |
The application name for the subclient. If the application name is not known, use the GET Subclient API to retrieve it. |
Yes-for the request by name |
|
instanceName |
The instance name for the subclient. If the backup set name is not known, use the GET Subclient API to retrieve it. |
Yes-for the request by name |
|
backupsetName |
The backup set name of the subclient. If the backup set name is not known, use the GET Subclient API to retrieve it. |
Yes-for the request by name |
|
subclientName |
The subclient name of the subclient. If the subclient name is not known, use the GET Subclient API to retrieve it. |
Yes-for the request by name |
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Web Console used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json.. |
|
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
|
Content-type |
The media type contained in the request body. |
Response
Response Parameters
|
Parameter |
Description |
Element |
|---|---|---|
|
subclientId |
The system-generated ID of the subclient |
entity |
|
applicationId |
The ID of the application. |
entity |
|
clientName |
Name of the client. |
entity |
|
backupsetId |
The ID of the backup set. |
entity |
|
instanceId |
The ID of the instance. |
entity |
|
clientId |
The ID of the client. |
entity |
|
subclientName |
Name of the subclient that you have offboarded. |
entity |
Examples
Example Request
POST Subclient/byName(clientName='vsaqa.company.com',appName='Virtual Server',instanceName='VMware',backupsetName='vsphere.local',subclientName='Gold')/Offboard
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json
Example Response
{ "errorMessage":"Successfully offboarded", "errorCode":0, "entity":{ "subclientId":20, "applicationId":106, "clientName":"vsaqa.company.com", "backupsetId":9, "instanceId":4, "clientId":3, "subclientName":"Gold" }
}
