Create DocumentDB cluster group

Select

SaaS

Customer Managed

This operation creates a new DocumentDB subclient (cluster group).

application/json

Request Body

• subClientProperties object

  subClientEntity object

  clientName string required

  Name of cloud account

  instanceName string required

  Name of Instance

  appName string

  backupsetName string

  Default value: defaultBackupSet

  subclientName string required

  Name of cluster group to be created

  cloudDbContent object

  children object[]

  displayName string

  name string required

  Name of DocumentDB cluster

  path string required

  Region of DocumentDB cluster

  type string required

  allOrAnyChildren boolean

  negation boolean

  cloudDbFilter object

  commonProperties object

  numberOfBackupStreams integer

Responses

• 200
• 400
• 409
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object

  warningCode integer

  errorCode integer

  warningMessage string

  entity object

  subclientId integer

  _type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "string",
    "entity": {
      "subclientId": 0,
      "_type_": 0
    }
  }
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "",
    "entity": {
      "subclientId": 16201,
      "_type_": 0
    }
  }
}

Bad Request

Conflict

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "A subclient by this name already exists as part of this backup set.",
  "errorCode": 3
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Failed to create new subclient.",
  "errorCode": 1
}

POST /subclient    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://ServerURL/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Example 1

---

{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "appName": "string",
      "backupsetName": "defaultBackupSet",
      "subclientName": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "displayName": "string",
          "name": "string",
          "path": "string",
          "type": "string",
          "allOrAnyChildren": true,
          "negation": true
        }
      ]
    },
    "cloudDbFilter": {},
    "commonProperties": {
      "numberOfBackupStreams": 0
    }
  }
}

curl -L -X POST 'https://ServerURL/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "appName": "string",
      "backupsetName": "defaultBackupSet",
      "subclientName": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "displayName": "string",
          "name": "string",
          "path": "string",
          "type": "string",
          "allOrAnyChildren": true,
          "negation": true
        }
      ]
    },
    "cloudDbFilter": {},
    "commonProperties": {
      "numberOfBackupStreams": 0
    }
  }
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "appName": "string",
      "backupsetName": "defaultBackupSet",
      "subclientName": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "displayName": "string",
          "name": "string",
          "path": "string",
          "type": "string",
          "allOrAnyChildren": true,
          "negation": true
        }
      ]
    },
    "cloudDbFilter": {},
    "commonProperties": {
      "numberOfBackupStreams": 0
    }
  }
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "appName": "string",
      "backupsetName": "defaultBackupSet",
      "subclientName": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "displayName": "string",
          "name": "string",
          "path": "string",
          "type": "string",
          "allOrAnyChildren": true,
          "negation": true
        }
      ]
    },
    "cloudDbFilter": {},
    "commonProperties": {
      "numberOfBackupStreams": 0
    }
  }
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "appName": "string",
      "backupsetName": "defaultBackupSet",
      "subclientName": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "displayName": "string",
          "name": "string",
          "path": "string",
          "type": "string",
          "allOrAnyChildren": true,
          "negation": true
        }
      ]
    },
    "cloudDbFilter": {},
    "commonProperties": {
      "numberOfBackupStreams": 0
    }
  }
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "appName": "string",
      "backupsetName": "defaultBackupSet",
      "subclientName": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "displayName": "string",
          "name": "string",
          "path": "string",
          "type": "string",
          "allOrAnyChildren": true,
          "negation": true
        }
      ]
    },
    "cloudDbFilter": {},
    "commonProperties": {
      "numberOfBackupStreams": 0
    }
  }
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "appName": "string",
      "backupsetName": "defaultBackupSet",
      "subclientName": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "displayName": "string",
          "name": "string",
          "path": "string",
          "type": "string",
          "allOrAnyChildren": true,
          "negation": true
        }
      ]
    },
    "cloudDbFilter": {},
    "commonProperties": {
      "numberOfBackupStreams": 0
    }
  }
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "appName": "string",
      "backupsetName": "defaultBackupSet",
      "subclientName": "string"
    },
    "cloudDbContent": {
      "children": [
        {
          "displayName": "string",
          "name": "string",
          "path": "string",
          "type": "string",
          "allOrAnyChildren": true,
          "negation": true
        }
      ]
    },
    "cloudDbFilter": {},
    "commonProperties": {
      "numberOfBackupStreams": 0
    }
  }
}'