Skip to main content

Full backup of couchbase instance​

This API is used to run a full backup of couchbase instance.

Request Body
  • taskInfo object required
  • task object
  • taskType integer

    Default value: 1

  • associations object[] required

    Provide instance

  • clientName string

    Couchbase instance name

  • instanceName string

    Couchbase instance name

  • backupsetId integer

    Default backupset ID

  • instanceId integer

    Use Get client Id to fetch

  • subclientId integer

    Subclient ID

  • clientId integer

    Client ID of the couchbase instance

  • appName string

    Default value: Big Data Apps

    Default

  • backupsetName string

    Backupset name

  • applicationId integer

    Default value: 64

    Internal field

  • subclientName string

    Default or user defined subclient name

  • entityInfo object
  • companyId integer
  • companyName string
  • subTasks object[] required
  • subTask object required
  • subTaskType integer required

    Default value: 2

  • operationType integer required

    Default value: 2

  • options object
  • backupOpts object
  • backupLevel string required

    Possible values: [FULL, INCREMENTAL]

    Backup Level

  • dataOpt object
  • createNewIndex boolean

    Default value: true

  • commonOpts object
  • notifyUserOnJobCompletion boolean

    Send email on job completion

Responses

OK

Schema
  • taskId integer
  • jobIds string[]
POST /createtask

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
Security Scheme
token
Body
{

  "taskInfo": {

    "task": {

      "taskType": 1

    },

    "associations": [

      {

        "clientName": "string",

        "instanceName": "string",

        "backupsetId": 0,

        "instanceId": 0,

        "subclientId": 0,

        "clientId": 0,

        "appName": "Big Data Apps",

        "backupsetName": "string",

        "applicationId": 64,

        "subclientName": "string",

        "entityInfo": {

          "companyId": 0,

          "companyName": "string"

        }

      }

    ],

    "subTasks": [

      {

        "subTask": {

          "subTaskType": 2,

          "operationType": 2

        },

        "options": {

          "backupOpts": {

            "backupLevel": "FULL",

            "dataOpt": {

              "createNewIndex": true

            }

          },

          "commonOpts": {

            "notifyUserOnJobCompletion": true

          }

        }

      }

    ]

  }

}

curl -L -X POST 'https://localhost/webconsole/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": 1
    },
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientId": 0,
        "clientId": 0,
        "appName": "Big Data Apps",
        "backupsetName": "string",
        "applicationId": 64,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string"
        }
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "backupLevel": "FULL",
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'