Skip to main content

AWS DocumentDB cluster backup

This operation starts a backup job of DocumentDB

Request Body
  • taskInfo object
  • associations object[]
  • clientName string required

    Name of cloud account

  • instanceName string required

    Name of instance

  • displayName string
  • backupsetId integer
  • _type_ integer
  • commCellName string
  • instanceId integer
  • subclientId integer
  • clientId integer
  • appName string
  • backupsetName string

    Default value: defaultBackupSet

  • applicationId integer
  • subclientName string required

    Name of cluster group

  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • task object
  • taskType integer
  • subTasks object[]
  • subTask object
  • subTaskType integer required
  • operationType integer
  • options object
  • backupOpts object
  • backupLevel string required

    Default value: FULL

    Type of backup to be performed

  • commonOpts object
  • notifyUserOnJobCompletion boolean
  • adminOpts object
  • clientInstallOption object
  • installerOption object
  • User object
  • userId integer
  • userName string
Responses

OK


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

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://ServerURL/commandcenter/api
Security Scheme
token
Body

{
"taskInfo": {
"associations": [
{
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"commCellName": "string",
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "string",
"backupsetName": "defaultBackupSet",
"applicationId": 0,
"subclientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
}
],
"task": {
"taskType": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"backupOpts": {
"backupLevel": "FULL"
},
"commonOpts": {
"notifyUserOnJobCompletion": true
},
"adminOpts": {
"clientInstallOption": {
"installerOption": {
"User": {
"userId": 0,
"userName": "string"
}
}
}
}
}
}
]
}
}
curl -L -X POST 'https://ServerURL/commandcenter/api/createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"associations": [
{
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"commCellName": "string",
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "string",
"backupsetName": "defaultBackupSet",
"applicationId": 0,
"subclientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
}
],
"task": {
"taskType": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"backupOpts": {
"backupLevel": "FULL"
},
"commonOpts": {
"notifyUserOnJobCompletion": true
},
"adminOpts": {
"clientInstallOption": {
"installerOption": {
"User": {
"userId": 0,
"userName": "string"
}
}
}
}
}
}
]
}
}'