Creates a couchbase Bucketgroup/subclient

Select

SaaS

Customer Managed

This API is used to create couchbase bucketgroup/subclient

application/json

Request Body

• subClientProperties object required

  fsContentOperationType string

  Default value: OVERWRITE

  subClientEntity object required

  clientId integer

  applicationId integer

  Default value: 64

  Internal field

  subclientName string

  subclient name

  planEntity object

  planId integer

  content object[] required

  List of contents to backup

  path string

  Individual content path

  useLocalContent boolean

  Set to true for override plan content

  dfsSubclientProp object

  distributedDataAccessNodes object

  dataAccessNodes object[]

  Couchbase access nodes

  hostName string

  clientId integer

  Client ID of the access node

  clientName string

  Client name of the access node

  displayName string

Responses

• 200
• 401

---

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": 6,
      "_type_": 0
    }
  }
}

Unauthorized

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

POST /subclient    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Example 1

---

{
  "subClientProperties": {
    "fsContentOperationType": "OVERWRITE",
    "subClientEntity": {
      "clientId": 0,
      "applicationId": 64,
      "subclientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "content": [
      {
        "path": "string"
      }
    ],
    "useLocalContent": true,
    "dfsSubclientProp": {
      "distributedDataAccessNodes": {
        "dataAccessNodes": [
          {
            "hostName": "string",
            "clientId": 0,
            "clientName": "string",
            "displayName": "string"
          }
        ]
      }
    }
  }
}

curl -L -X POST 'https://localhost/webconsole/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "fsContentOperationType": "OVERWRITE",
    "subClientEntity": {
      "clientId": 0,
      "applicationId": 64,
      "subclientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "content": [
      {
        "path": "string"
      }
    ],
    "useLocalContent": true,
    "dfsSubclientProp": {
      "distributedDataAccessNodes": {
        "dataAccessNodes": [
          {
            "hostName": "string",
            "clientId": 0,
            "clientName": "string",
            "displayName": "string"
          }
        ]
      }
    }
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "fsContentOperationType": "OVERWRITE",
    "subClientEntity": {
      "clientId": 0,
      "applicationId": 64,
      "subclientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "content": [
      {
        "path": "string"
      }
    ],
    "useLocalContent": true,
    "dfsSubclientProp": {
      "distributedDataAccessNodes": {
        "dataAccessNodes": [
          {
            "hostName": "string",
            "clientId": 0,
            "clientName": "string",
            "displayName": "string"
          }
        ]
      }
    }
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "fsContentOperationType": "OVERWRITE",
    "subClientEntity": {
      "clientId": 0,
      "applicationId": 64,
      "subclientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "content": [
      {
        "path": "string"
      }
    ],
    "useLocalContent": true,
    "dfsSubclientProp": {
      "distributedDataAccessNodes": {
        "dataAccessNodes": [
          {
            "hostName": "string",
            "clientId": 0,
            "clientName": "string",
            "displayName": "string"
          }
        ]
      }
    }
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "fsContentOperationType": "OVERWRITE",
    "subClientEntity": {
      "clientId": 0,
      "applicationId": 64,
      "subclientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "content": [
      {
        "path": "string"
      }
    ],
    "useLocalContent": true,
    "dfsSubclientProp": {
      "distributedDataAccessNodes": {
        "dataAccessNodes": [
          {
            "hostName": "string",
            "clientId": 0,
            "clientName": "string",
            "displayName": "string"
          }
        ]
      }
    }
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "fsContentOperationType": "OVERWRITE",
    "subClientEntity": {
      "clientId": 0,
      "applicationId": 64,
      "subclientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "content": [
      {
        "path": "string"
      }
    ],
    "useLocalContent": true,
    "dfsSubclientProp": {
      "distributedDataAccessNodes": {
        "dataAccessNodes": [
          {
            "hostName": "string",
            "clientId": 0,
            "clientName": "string",
            "displayName": "string"
          }
        ]
      }
    }
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "fsContentOperationType": "OVERWRITE",
    "subClientEntity": {
      "clientId": 0,
      "applicationId": 64,
      "subclientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "content": [
      {
        "path": "string"
      }
    ],
    "useLocalContent": true,
    "dfsSubclientProp": {
      "distributedDataAccessNodes": {
        "dataAccessNodes": [
          {
            "hostName": "string",
            "clientId": 0,
            "clientName": "string",
            "displayName": "string"
          }
        ]
      }
    }
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "fsContentOperationType": "OVERWRITE",
    "subClientEntity": {
      "clientId": 0,
      "applicationId": 64,
      "subclientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "content": [
      {
        "path": "string"
      }
    ],
    "useLocalContent": true,
    "dfsSubclientProp": {
      "distributedDataAccessNodes": {
        "dataAccessNodes": [
          {
            "hostName": "string",
            "clientId": 0,
            "clientName": "string",
            "displayName": "string"
          }
        ]
      }
    }
  }
}'