Backup

Select

SaaS

Customer Managed

Backup operation on objecct storage subclient

application/json

Request Body

• taskInfo object

  task object required

  taskType string required

  associations object[] required

  clientName string

  instanceName string

  displayName string

  DisplayName is same as the client

  _type_ string

  commCellName string

  appName string

  backupsetName string

  Backup set name for object storage instances will be "defaultBackupSet"

  applicationId integer

  subclientName string

  subTasks object[] required

  subTask object

  subTaskType string

  operationType string

  options object

  backupOpts object

  backupLevel string

  dataOpt object

  createNewIndex boolean

  commonOpts object

  notifyUserOnJobCompletion boolean

Responses

• 200
• 400

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• taskId integer
• jobIds string[]

{
  "taskId": 0,
  "jobIds": [
    "string"
  ]
}

{
  "taskId": 1083,
  "jobIds": [
    "9362"
  ]
}

Bad Request

application/json

• Schema
• Example 1

---

Schema

• string

Request body is empty or format is invalid.

POST /createtask    

Request

Click Edit to configure Base URL

https://CommandCenterHostName/webconsole/api

Content-Type

application/jsonapplication/xml

Body

• Default
• Incremental backup
• Synthetic Full backup
• Full Backup

---

{
  "taskInfo": {
    "task": {
      "taskType": "string"
    },
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "string",
        "commCellName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "string",
          "operationType": "string"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "string"
    },
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "string",
        "commCellName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "string",
          "operationType": "string"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "string"
    },
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "string",
        "commCellName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "string",
          "operationType": "string"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "string"
    },
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "string",
        "commCellName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "string",
          "operationType": "string"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "string"
    },
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "string",
        "commCellName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "string",
          "operationType": "string"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "string"
    },
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "string",
        "commCellName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "string",
          "operationType": "string"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "string"
    },
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "string",
        "commCellName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "string",
          "operationType": "string"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/CreateTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "string"
    },
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "string",
        "commCellName": "string",
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "string",
          "operationType": "string"
        },
        "options": {
          "backupOpts": {
            "backupLevel": "string",
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'