Backup of Splunk cluster

This operation is used to run a Splunk cluster backups.

application/json

Request Body

taskInfo object
task object
taskType integer
associations object[]
clientName string
instanceName string
displayName string
backupsetId integer
_type_ string
commCellName string
instanceId integer
csGUID string
subclientGUID string
subclientId integer
clientId integer
appName string
backupsetName string
applicationId integer
subclientName string
entityInfo object
companyId integer
companyName string
multiCommcellId integer
subTasks object[]
subTask object
subTaskType integer
operationType integer
options object
backupOpts object
backupLevel string
dataOpt object
createNewIndex boolean
commonOpts object
notifyUserOnJobCompletion boolean

Responses

application/json

Schema
Example (from schema)
Incremental Splunk backup

Schema

taskInfo object
task object
taskType integer
associations object[]
clientName string
instanceName string
displayName string
backupsetId integer
_type_ string
commCellName string
instanceId integer
csGUID string
subclientGUID string
subclientId integer
clientId integer
appName string
backupsetName string
applicationId integer
subclientName string
entityInfo object
companyId integer
companyName string
multiCommcellId integer
subTasks object[]
subTask object
subTaskType integer
operationType integer
options object
backupOpts object
backupLevel string
dataOpt object
createNewIndex boolean
commonOpts object
notifyUserOnJobCompletion boolean

{
  "taskInfo": {
    "task": {
      "taskType": 0
    },
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": "string",
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}

{
  "taskInfo": {
    "task": {
      "taskType": 1
    },
    "associations": [
      {
        "clientName": "xxxx",
        "instanceName": "xxx",
        "displayName": "xxxx",
        "backupsetId": 267,
        "_type_": "SUBCLIENT_ENTITY",
        "commCellName": "xxx",
        "instanceId": 210,
        "csGUID": "CCFABDEC-B720-4B50-8133-F50D2FE1E229",
        "subclientGUID": "0B4A8362-ACB2-41CF-A583-3748FD9C30BF",
        "subclientId": 343,
        "clientId": 212,
        "appName": "Big Data Apps",
        "backupsetName": "defaultBackupSet",
        "applicationId": 64,
        "subclientName": "default",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "backupLevel": "INCREMENTAL",
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false
          }
        }
      }
    ]
  }
}

Bad Request

application/json

Schema
Example 1

Schema

string

Request body is empty or format is invalid

Unauthorized

application/json

Schema
Example (from schema)
Example 1

Schema

errorMessage string
errorCode integer

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

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

Not Found

application/json

Schema
Example (from schema)
Example 1

Schema

errorMessage string
errorCode integer

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

{
  "errorMessage": "No instance is specified",
  "errorCode": 4
}

application/json

Schema
Example (from schema)
Incremental backup of Splunk cluster

Schema

taskInfo object
task object
taskType integer
associations object[]
clientName string
instanceName string
displayName string
backupsetId integer
_type_ string
commCellName string
instanceId integer
csGUID string
subclientGUID string
subclientId integer
clientId integer
appName string
backupsetName string
applicationId integer
subclientName string
entityInfo object
companyId integer
companyName string
multiCommcellId integer
subTasks object[]
subTask object
subTaskType integer
operationType integer
options object
backupOpts object
backupLevel string
dataOpt object
createNewIndex boolean
commonOpts object
notifyUserOnJobCompletion boolean

{
  "taskInfo": {
    "task": {
      "taskType": 0
    },
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": "string",
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}

{
  "taskInfo": {
    "task": {
      "taskType": 1
    },
    "associations": [
      {
        "clientName": "splunk clientname",
        "instanceName": "splunk instancename",
        "displayName": "splunk client displayed in UI",
        "backupsetId": 267,
        "_type_": "SUBCLIENT_ENTITY",
        "commCellName": "cs name",
        "instanceId": 210,
        "csGUID": "CCFABDEC-B720-4B50-8133-F50D2FE1E229",
        "subclientGUID": "0B4A8362-ACB2-41CF-A583-3748FD9C30BF",
        "subclientId": 343,
        "clientId": 212,
        "appName": "Big Data Apps",
        "backupsetName": "defaultBackupSet",
        "applicationId": 64,
        "subclientName": "default",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "backupLevel": "INCREMENTAL",
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false
          }
        }
      }
    ]
  }
}

Backup of Splunk cluster​

Backup of Splunk cluster