Skip to main content

Create new Send logs job​

Select

SaaS
Customer Managed

This operation is used to trigger a new send logs job

Request Body
  • taskInfo object
  • task object
  • taskFlags object
  • disabled boolean required
  • taskType integer required
  • initiatedFrom integer required
  • policyType integer
  • subTasks object[]
  • subTask object
  • subTaskType integer required
  • operationType integer required
  • options object
  • adminOpts object
  • sendLogFilesOption object

    To specify which logs are to be collected

  • actionLogsEndJobId integer
  • emailSelected boolean

    Default value: true

  • jobid integer
  • tsDatabase boolean
  • galaxyLogs boolean

    Default value: true

  • getLatestUpdates boolean
  • actionLogsStartJobId integer
  • computersSelected boolean
  • csDatabase boolean

    Collect logs of the CommServ DB

  • otherDatabases boolean

    Collect logs of other DB

  • crashDump boolean
  • isNetworkPath boolean
  • saveToFolderSelected boolean
  • notifyMe boolean

    Default value: true

  • includeJobResults boolean
  • doNotIncludeLogs boolean

    Default value: true

  • machineInformation boolean

    Default value: true

  • scrubLogFiles boolean
  • emailSubject string

    CS_Name : Commcell ID **** Logs for machines: Machine_Name

  • osLogs boolean

    Default value: true

  • allUsersProfile boolean
  • splitFileSizeMB integer

    Default value: 512

  • actionLogs boolean
  • includeIndex boolean
  • databaseLogs boolean

    Default value: true

  • includeDCDB boolean
  • collectHyperScale boolean
  • logFragments boolean
  • uploadLogsSelected boolean
  • useDefaultUploadOption boolean
  • enableChunking boolean

    Default value: true

  • collectRFC boolean
  • collectUserAppLogs boolean
  • impersonateUser object
  • useImpersonation boolean
  • clients string[]
  • clientId integer
  • clientName string
  • recipientCc object
  • emailids array
  • users array
  • userGroups array
  • sendLogsOnJobCompletion boolean
Responses

OK

Schema
  • taskId integer
  • jobIds string[]
POST /createtask

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "taskInfo": {

    "task": {

      "taskFlags": {

        "disabled": true

      },

      "taskType": 0,

      "initiatedFrom": 0,

      "policyType": 0

    },

    "subTasks": [

      {

        "subTask": {

          "subTaskType": 0,

          "operationType": 0

        },

        "options": {

          "adminOpts": {

            "sendLogFilesOption": {

              "actionLogsEndJobId": 0,

              "emailSelected": true,

              "jobid": 0,

              "tsDatabase": true,

              "galaxyLogs": true,

              "getLatestUpdates": true,

              "actionLogsStartJobId": 0,

              "computersSelected": true,

              "csDatabase": true,

              "otherDatabases": true,

              "crashDump": true,

              "isNetworkPath": true,

              "saveToFolderSelected": true,

              "notifyMe": true,

              "includeJobResults": true,

              "doNotIncludeLogs": true,

              "machineInformation": true,

              "scrubLogFiles": true,

              "emailSubject": "string",

              "osLogs": true,

              "allUsersProfile": true,

              "splitFileSizeMB": 512,

              "actionLogs": true,

              "includeIndex": true,

              "databaseLogs": true,

              "includeDCDB": true,

              "collectHyperScale": true,

              "logFragments": true,

              "uploadLogsSelected": true,

              "useDefaultUploadOption": true,

              "enableChunking": true,

              "collectRFC": true,

              "collectUserAppLogs": true,

              "impersonateUser": {

                "useImpersonation": true

              },

              "clients": [

                "string"

              ],

              "recipientCc": {

                "emailids": [

                  null

                ],

                "users": [

                  null

                ],

                "userGroups": [

                  null

                ]

              },

              "sendLogsOnJobCompletion": 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": {
      "taskFlags": {
        "disabled": true
      },
      "taskType": 0,
      "initiatedFrom": 0,
      "policyType": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "adminOpts": {
            "sendLogFilesOption": {
              "actionLogsEndJobId": 0,
              "emailSelected": true,
              "jobid": 0,
              "tsDatabase": true,
              "galaxyLogs": true,
              "getLatestUpdates": true,
              "actionLogsStartJobId": 0,
              "computersSelected": true,
              "csDatabase": true,
              "otherDatabases": true,
              "crashDump": true,
              "isNetworkPath": true,
              "saveToFolderSelected": true,
              "notifyMe": true,
              "includeJobResults": true,
              "doNotIncludeLogs": true,
              "machineInformation": true,
              "scrubLogFiles": true,
              "emailSubject": "string",
              "osLogs": true,
              "allUsersProfile": true,
              "splitFileSizeMB": 512,
              "actionLogs": true,
              "includeIndex": true,
              "databaseLogs": true,
              "includeDCDB": true,
              "collectHyperScale": true,
              "logFragments": true,
              "uploadLogsSelected": true,
              "useDefaultUploadOption": true,
              "enableChunking": true,
              "collectRFC": true,
              "collectUserAppLogs": true,
              "impersonateUser": {
                "useImpersonation": true
              },
              "clients": [
                "string"
              ],
              "recipientCc": {
                "emailids": [
                  null
                ],
                "users": [
                  null
                ],
                "userGroups": [
                  null
                ]
              },
              "sendLogsOnJobCompletion": true
            }
          }
        }
      }
    ]
  }
}'