Full backup of a MongoDB instance

Select

SaaS

Customer Managed

This operation is used to backup a MongoDB instance

application/json

Request Body

• taskInfo object

  associations object[]

  subclientId integer

  MongoDB

  displayName string required

  MongoDB instance display name

  clientId integer

  MongoDB instance client Id

  instanceName string required

  MongoDB instance name

  appName string

  Default value: Big Data Apps

  applicationId integer

  Default value: 64

  clientName string required

  MongoDB instance client name

  backupsetId integer

  MongoDB backupset Id

  instanceId integer

  MongoDB instance ID

  subclientName string required

  Default value: default

  MongoDB instance subclient name i.e. default

  backupsetName string required

  Default value: defaultBackupSet

  MongoDb instance backupset name i.e defaultBackupSet

  _type_ integer

  Default value: 7

  task object

  taskType integer

  Default value: 1

  subTasks object[]

  subTask object

  subTaskType integer

  Default value: 2

  operationType integer

  Default value: 2

  options object

  backupOpts object

  backupLevel integer

  Default value: 1

  commonOpts object

  notifyUserOnJobCompletion boolean

  Default value: false

  subscriptionInfo string

Responses

• 200
• 400
• 401
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• taskId integer
• jobIds string[]

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "taskId": 0,
  "jobIds": [
    "string"
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "WebServer",
        "value": "OBLIVION"
      }
    ]
  },
  "taskId": 6026,
  "jobIds": [
    "34350"
  ]
}

Bad Request

application/json

• Schema
• Example

---

Schema

• string

Request body is empty or format is invalid

application/xml

• Schema
• Example (from schema)

---

Schema

• object

<root/>

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

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

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

Not found

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

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

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

POST /createtask    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Backup MongoDB instance

---

{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "Big Data Apps",
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "default",
        "backupsetName": "defaultBackupSet",
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "backupLevel": 1
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false,
            "subscriptionInfo": "string"
          }
        }
      }
    ]
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "Big Data Apps",
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "default",
        "backupsetName": "defaultBackupSet",
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "backupLevel": 1
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false,
            "subscriptionInfo": "string"
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "Big Data Apps",
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "default",
        "backupsetName": "defaultBackupSet",
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "backupLevel": 1
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false,
            "subscriptionInfo": "string"
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "Big Data Apps",
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "default",
        "backupsetName": "defaultBackupSet",
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "backupLevel": 1
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false,
            "subscriptionInfo": "string"
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "Big Data Apps",
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "default",
        "backupsetName": "defaultBackupSet",
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "backupLevel": 1
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false,
            "subscriptionInfo": "string"
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "Big Data Apps",
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "default",
        "backupsetName": "defaultBackupSet",
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "backupLevel": 1
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false,
            "subscriptionInfo": "string"
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "Big Data Apps",
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "default",
        "backupsetName": "defaultBackupSet",
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "backupLevel": 1
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false,
            "subscriptionInfo": "string"
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "Big Data Apps",
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subclientName": "default",
        "backupsetName": "defaultBackupSet",
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "backupLevel": 1
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false,
            "subscriptionInfo": "string"
          }
        }
      }
    ]
  }
}'