Backup Subclient

Select

SaaS

Customer Managed

This operation performs a backup on a MSSQL subclient

application/json

Request Body

• taskInfo object

  associations object[]

  instanceId integer required

  subclientId integer required

  clientId integer required

  appName string required

  Default value: SQL Server

  entityInfo object

  companyId integer

  companyName string

  Default value: Commcell

  multiCommcellId integer

  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 required

  Possible values: [FULL, TRANSACTION_LOG, DIFFERENTIAL]

  dataOpt object

  copyOnly boolean

  Default value: false

  Applicable only for full backups. To run copy-only full set to true

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• taskId integer
• jobIds string[]

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

{
  "taskId": 30453,
  "jobIds": [
    "149806"
  ]
}

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

  Default value: Access denied

• errorCode integer

  Default value: 5

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

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

POST /createtask    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Full backup
• Differential Backup
• Transaction Log Backup

---

{
  "taskInfo": {
    "associations": [
      {
        "instanceId": 0,
        "subclientId": 0,
        "clientId": 0,
        "appName": "SQL Server",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "dataOpt": {
              "copyOnly": false
            }
          }
        }
      }
    ]
  }
}

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": [
      {
        "instanceId": 0,
        "subclientId": 0,
        "clientId": 0,
        "appName": "SQL Server",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "dataOpt": {
              "copyOnly": false
            }
          }
        }
      }
    ]
  }
}'

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": [
      {
        "instanceId": 0,
        "subclientId": 0,
        "clientId": 0,
        "appName": "SQL Server",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "dataOpt": {
              "copyOnly": false
            }
          }
        }
      }
    ]
  }
}'

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": [
      {
        "instanceId": 0,
        "subclientId": 0,
        "clientId": 0,
        "appName": "SQL Server",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "dataOpt": {
              "copyOnly": false
            }
          }
        }
      }
    ]
  }
}'

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": [
      {
        "instanceId": 0,
        "subclientId": 0,
        "clientId": 0,
        "appName": "SQL Server",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "dataOpt": {
              "copyOnly": false
            }
          }
        }
      }
    ]
  }
}'

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": [
      {
        "instanceId": 0,
        "subclientId": 0,
        "clientId": 0,
        "appName": "SQL Server",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "dataOpt": {
              "copyOnly": false
            }
          }
        }
      }
    ]
  }
}'

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": [
      {
        "instanceId": 0,
        "subclientId": 0,
        "clientId": 0,
        "appName": "SQL Server",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "dataOpt": {
              "copyOnly": false
            }
          }
        }
      }
    ]
  }
}'

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": [
      {
        "instanceId": 0,
        "subclientId": 0,
        "clientId": 0,
        "appName": "SQL Server",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 2,
          "operationType": 2
        },
        "options": {
          "backupOpts": {
            "dataOpt": {
              "copyOnly": false
            }
          }
        }
      }
    ]
  }
}'