Client Update Software

Select

SaaS

Customer Managed

This operation updates software on the client.

application/json

Request Body

• taskInfo object

  task object

  taskType integer

  subTasks object[]

  subTask object

  subTaskType integer

  operationType integer

  options object

  adminOpts object

  updateOption object

  ignoreRunningJobs boolean

  rebootClient boolean

  clientAndClientGroups object[]

  clientSidePackage boolean

  clientId integer

  consumeLicense boolean

  clientId integer[]

  installUpdatesJobType object

  installUpdates boolean

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• taskId integer
• jobIds string[]

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

{
  "taskId": 732,
  "jobIds": [
    "23657"
  ]
}

POST /createtask    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• ClientGroup Update Software
• Client Update Software

---

{
  "taskInfo": {
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "ignoreRunningJobs": true,
              "rebootClient": true,
              "clientAndClientGroups": [
                {
                  "clientSidePackage": true,
                  "clientId": 0,
                  "consumeLicense": true
                }
              ],
              "clientId": [
                0
              ],
              "installUpdatesJobType": {
                "installUpdates": true
              }
            }
          }
        }
      }
    ]
  }
}

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": {
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "ignoreRunningJobs": true,
              "rebootClient": true,
              "clientAndClientGroups": [
                {
                  "clientSidePackage": true,
                  "clientId": 0,
                  "consumeLicense": true
                }
              ],
              "clientId": [
                0
              ],
              "installUpdatesJobType": {
                "installUpdates": true
              }
            }
          }
        }
      }
    ]
  }
}'

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": {
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "ignoreRunningJobs": true,
              "rebootClient": true,
              "clientAndClientGroups": [
                {
                  "clientSidePackage": true,
                  "clientId": 0,
                  "consumeLicense": true
                }
              ],
              "clientId": [
                0
              ],
              "installUpdatesJobType": {
                "installUpdates": true
              }
            }
          }
        }
      }
    ]
  }
}'

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": {
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "ignoreRunningJobs": true,
              "rebootClient": true,
              "clientAndClientGroups": [
                {
                  "clientSidePackage": true,
                  "clientId": 0,
                  "consumeLicense": true
                }
              ],
              "clientId": [
                0
              ],
              "installUpdatesJobType": {
                "installUpdates": true
              }
            }
          }
        }
      }
    ]
  }
}'

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": {
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "ignoreRunningJobs": true,
              "rebootClient": true,
              "clientAndClientGroups": [
                {
                  "clientSidePackage": true,
                  "clientId": 0,
                  "consumeLicense": true
                }
              ],
              "clientId": [
                0
              ],
              "installUpdatesJobType": {
                "installUpdates": true
              }
            }
          }
        }
      }
    ]
  }
}'

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": {
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "ignoreRunningJobs": true,
              "rebootClient": true,
              "clientAndClientGroups": [
                {
                  "clientSidePackage": true,
                  "clientId": 0,
                  "consumeLicense": true
                }
              ],
              "clientId": [
                0
              ],
              "installUpdatesJobType": {
                "installUpdates": true
              }
            }
          }
        }
      }
    ]
  }
}'

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": {
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "ignoreRunningJobs": true,
              "rebootClient": true,
              "clientAndClientGroups": [
                {
                  "clientSidePackage": true,
                  "clientId": 0,
                  "consumeLicense": true
                }
              ],
              "clientId": [
                0
              ],
              "installUpdatesJobType": {
                "installUpdates": true
              }
            }
          }
        }
      }
    ]
  }
}'

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": {
    "task": {
      "taskType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "ignoreRunningJobs": true,
              "rebootClient": true,
              "clientAndClientGroups": [
                {
                  "clientSidePackage": true,
                  "clientId": 0,
                  "consumeLicense": true
                }
              ],
              "clientId": [
                0
              ],
              "installUpdatesJobType": {
                "installUpdates": true
              }
            }
          }
        }
      }
    ]
  }
}'