Subclient Offboard

This operation offboards a subclient.

More Details

Path Parameters

• clientName string required
• subclientName string required
• appName string required

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Subclient Offboard - With I D / Subclient/{{subclient Id}}/ Offboard
• Subclient Offboard - With Subclient Name

---

Schema

• errorMessage string
• errorCode integer
• entity object

  subclientId integer

  applicationId integer

  clientName string

  backupsetId integer

  instanceId integer

  clientId integer

  subclientName string

{
  "errorMessage": "string",
  "errorCode": 0,
  "entity": {
    "subclientId": 0,
    "applicationId": 0,
    "clientName": "string",
    "backupsetId": 0,
    "instanceId": 0,
    "clientId": 0,
    "subclientName": "string"
  }
}

{
  "errorMessage": "Successfully offboarded",
  "errorCode": 0,
  "entity": {
    "subclientId": 63,
    "applicationId": 33,
    "clientName": "dm2perf3",
    "backupsetId": 3,
    "instanceId": 1,
    "clientId": 2,
    "subclientName": "backedup_test"
  }
}

{
  "errorMessage": "Successfully offboarded",
  "errorCode": 0,
  "entity": {
    "subclientId": 63,
    "applicationId": 33,
    "clientName": "dm2perf3",
    "backupsetId": 3,
    "instanceId": 1,
    "clientId": 2,
    "subclientName": "backedup_test"
  }
}

POST /Subclient/byName(clientName=':clientName',appName=':appName',instanceName='DefaultInstanceName',backupsetName='defaultBackupSet',subclientName=':subclientName')/Offboard    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

clientName — path required

subclientName — path required

appName — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'