Delete DocumentDB cluster group

Select

SaaS

Customer Managed

This operation deletes the subclient (cluster group)

Path Parameters

• subclientid string required

  ID of the subclient

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object[]

  errorCode integer

  entity object

  subclientId integer

  clientId integer

  instanceName string

  appName string

  clientName string

  subclientName string

  backupsetName string

  _type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "errorCode": 0,
      "entity": {
        "subclientId": 0,
        "clientId": 0,
        "instanceName": "string",
        "appName": "string",
        "clientName": "string",
        "subclientName": "string",
        "backupsetName": "string",
        "_type_": 0
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "errorCode": 0,
      "entity": {
        "subclientId": 196,
        "clientId": 19,
        "instanceName": "DocumentDB",
        "appName": "Cloud Apps",
        "clientName": "cloud_acc_name",
        "subclientName": "api-test-subclient",
        "backupsetName": "defaultBackupSet",
        "_type_": 0
      }
    }
  ]
}

DELETE /subclient/:subclientid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://ServerURL/commandcenter/api

Security Scheme

tokenbearerToken

token

subclientid — path required

curl -L -X DELETE 'https://ServerURL/commandcenter/api/subclient/:subclientid' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X DELETE 'https://ServerURL/commandcenter/api/subclient/:subclientid' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X DELETE 'https://ServerURL/commandcenter/api/subclient/:subclientid' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X DELETE 'https://ServerURL/commandcenter/api/subclient/:subclientid' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X DELETE 'https://ServerURL/commandcenter/api/subclient/:subclientid' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X DELETE 'https://ServerURL/commandcenter/api/subclient/:subclientid' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X DELETE 'https://ServerURL/commandcenter/api/subclient/:subclientid' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'