Subclient Onboard

Select

SaaS

Customer Managed

This operation onboards a subclient.

More Details

Path Parameters

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

application/json

Request Body

• StoragePool string
• serviceLevel string
• ForceReplace boolean
• role object

  roleName string
• CycleDay object[]

  day integer

  time object[]

  startTime string

  endTime string
• user object

  userName string

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Subclient Onboard - With Subclient Name

---

Schema

• errorMessage string
• errorCode integer
• entity object

  subclientId integer

  userId integer

  subclientName string

  userName string

{
  "errorMessage": "string",
  "errorCode": 0,
  "entity": {
    "subclientId": 0,
    "userId": 0,
    "subclientName": "string",
    "userName": "string"
  }
}

{
  "errorMessage": "OnBoarding Subclient is successful",
  "errorCode": 0,
  "entity": {
    "subclientId": 63,
    "userId": 1251,
    "subclientName": "backedup_test",
    "userName": "tapicompany\\tapicompany"
  }
}

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

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

clientName — path required

appName — path required

subclientName — path required

Body

• Default
• Subclient Onboard - With Subclient ID
• Example 1

---

{
  "StoragePool": "string",
  "serviceLevel": "string",
  "ForceReplace": true,
  "role": {
    "roleName": "string"
  },
  "CycleDay": [
    {
      "day": 0,
      "time": [
        {
          "startTime": "string",
          "endTime": "string"
        }
      ]
    }
  ],
  "user": {
    "userName": "string"
  }
}

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

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

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

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

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

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

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