Salesforce Backup

Select

SaaS

Customer Managed

This operation is used to trigger Salesforce backups.

application/json

Request Body

• taskInfo object

  associations object[]

  backupsetId integer required

  BackupsetId of the Salesforce client

  instanceId integer required

  InstanceId of the Salesforce client

  clientId integer required

  ClientId of the Salesforce client

  entityInfo object

  companyId integer

  Company Id

  companyName string

  Company Name

  multiCommcellId integer

  clientName string

  Name of the Salesforce Client

  instanceName string

  Name of the Salesforce Client

  displayName string

  Name of the Salesforce Client

  task object

  taskType string required

  subTasks object[]

  subTask object

  subTaskType string required

  operationType string required

  options object

  backupOpts object

  backupLevel integer

  Possible values: >= 1 and <= 2

  Default value: 2

  Backup Type Ex: Full-1, Incremental-2

  dataOpt object

  createNewIndex boolean required

  Create New Index Ex: Full-true, Incremental-false

  commonOpts object

  notifyUserOnJobCompletion boolean

  Default value: false

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• taskId integer
• jobIds string[]

  Backup job Id

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

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
• Incremental Backup

---

{
  "taskInfo": {
    "associations": [
      {
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        },
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string"
      }
    ],
    "task": {
      "taskType": "\"IMMEDIATE\""
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "\"BACKUP\"",
          "operationType": "\"BACKUP\""
        },
        "options": {
          "backupOpts": {
            "backupLevel": 2,
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": 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": [
      {
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        },
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string"
      }
    ],
    "task": {
      "taskType": "\"IMMEDIATE\""
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "\"BACKUP\"",
          "operationType": "\"BACKUP\""
        },
        "options": {
          "backupOpts": {
            "backupLevel": 2,
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": 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": [
      {
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        },
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string"
      }
    ],
    "task": {
      "taskType": "\"IMMEDIATE\""
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "\"BACKUP\"",
          "operationType": "\"BACKUP\""
        },
        "options": {
          "backupOpts": {
            "backupLevel": 2,
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": 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": [
      {
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        },
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string"
      }
    ],
    "task": {
      "taskType": "\"IMMEDIATE\""
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "\"BACKUP\"",
          "operationType": "\"BACKUP\""
        },
        "options": {
          "backupOpts": {
            "backupLevel": 2,
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": 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": [
      {
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        },
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string"
      }
    ],
    "task": {
      "taskType": "\"IMMEDIATE\""
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "\"BACKUP\"",
          "operationType": "\"BACKUP\""
        },
        "options": {
          "backupOpts": {
            "backupLevel": 2,
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": 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": [
      {
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        },
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string"
      }
    ],
    "task": {
      "taskType": "\"IMMEDIATE\""
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "\"BACKUP\"",
          "operationType": "\"BACKUP\""
        },
        "options": {
          "backupOpts": {
            "backupLevel": 2,
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": 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": [
      {
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        },
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string"
      }
    ],
    "task": {
      "taskType": "\"IMMEDIATE\""
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "\"BACKUP\"",
          "operationType": "\"BACKUP\""
        },
        "options": {
          "backupOpts": {
            "backupLevel": 2,
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": 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": [
      {
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        },
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string"
      }
    ],
    "task": {
      "taskType": "\"IMMEDIATE\""
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "\"BACKUP\"",
          "operationType": "\"BACKUP\""
        },
        "options": {
          "backupOpts": {
            "backupLevel": 2,
            "dataOpt": {
              "createNewIndex": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false
          }
        }
      }
    ]
  }
}'