Use this API to get details of the deployment job based on the provided deployment job ID.
|
Parameter |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|
|
deploymentJobId |
Mandatory |
string |
Deployment job ID for which you want to fetch details. |
API request
curl -X GET
"https://<QualysBaseURL>/pm/v1/deploymentjob/330b9957-9434-4042-9d67-9a3260b6de45" -H "accept: application/json" -H "Authorization: Bearer <<jwt token>>"
Response
{
"customerId": "6f66747e-2800-7fc7-82d4-1ee7cd30c9fc",
"id": "330b9957-9434-4042-9d67-9a3260b6de45",
"schemaVersion": "1.0",
"name": "Windows Public API job ",
"type": "Install",
"status": "Assets Responded",
"assetIds": [
"a676efcf-8322-4fdc-b3b5-f3ed44f955a5"
],
"assetTagIds": null,
"matchAllTagIds": null,
"exclusionTagIds": null,
"exclusionAssetIds": null,
"coAuthorUserIds": null,
"approvedPatches": [
"49375711-2fb4-3286-a26b-73e2e86ec069"
],
"disabledPatches": null,
"patchCount": 1,
"scheduleType": "On-demand",
"startDateTime": "2021-12-14 01:13:24 PM",
"recurring": false,
"recurringWeekDays": "",
"dayOfMonth": null,
"recurringDayOfMonth": null,
"recurringWeekDayOfMonth": null,
"timezoneType": "SPECIFIC_TZ",
"timezone": "UTC",
"timeout": -1,
"timeoutUnit": "HOURS",
"preDeployment": {
"userMessage": "",
"description": "",
"deferment": {
"count": 3,
"interval": 1,
"intervalUnit": "HOURS"
}
},
"duringDeployment": {
"userMessage": "",
"description": ""
},
"postDeployment": {
"suppressReboots": false,
"rebootOption": {
"userMessage": "",
"description": "",
"deferment": {
"count": 3,
"interval": 1,
"intervalUnit": "HOURS"
}
},
"rebootCountdown": {
"interval": 15,
"intervalUnit": "MINUTES",
"userMessage": "Reboot countdown started",
"description": "The system reboot is initiated. It will reboot automatically after the timer countdown."
},
"onComplete": {
"userMessage": "",
"description": ""
}
},
"description": "Windows job created via public API",
"createdBy": {
"user": {
"id": "ea9067e4-1c28-e208-80b4-312b7a0449cf",
"name": "gtham_bw"
},
"date": 1639487598431
},
"updatedBy": {
"user": null,
"date": 1639487913081
},
"deletedBy": {
"user": null,
"date": null
},
"assetCount": null,
"opportunisticDownloads": false,
"filterType": "Any",
"exclusionFilterType": "Any",
"taggedAssetCount": 0,
"minimizeWindow": false,
"dynamicPatchesQQL": "",
"isDynamicPatchesQQL": false,
"dynamicQQLType": 1,
"platform": "Windows",
"continueOnPatchFailure": false,
"preDeployActions": [
{
"action": "Run Script",
"actionId": "a0d925e4-4577-472f-afc1-53907777ff2b",
"actionType": "predeploy",
"params": {
"actionItem": "Notepad detection script",
"timeout": 180
},
"script": "JHc2ND1HZXQtSXRlbVByb3BlcnR5IEhLTE06XFNvZnR3YXJlXFdvdzY0MzJOb2RlXE1pY3Jvc29mdFxXaW5kb3dzXEN1cnJlbnRWZXJzaW9uXFVuaW5zdGFsbFwqIHwgd2hlcmUtT2JqZWN0IERpc3BsYXlOYW1lIC1saWtlICdOb3RlUGFkKysqJwokdzMyPUdldC1JdGVtUHJvcGVydHkgSEtMTTpcU29mdHdhcmVcTWljcm9zb2Z0XFdpbmRvd3NcQ3VycmVudFZlcnNpb25cVW5pbnN0YWxsXCogIHwgd2hlcmUtT2JqZWN0IERpc3BsYXlOYW1lIC1saWtlICdOb3RlUGFkKysqJwppZiAoJHc2NCAtb3IgJHczMikKewogICAgV3JpdGUtb3V0cHV0ICJOb3RlcGFkKysgaXMgYWxyZWFkeSBpbnN0YWxsZWQgb24geW91ciBtYWNoaW5lLiIKfQpFbHNlewogICAgV3JpdGUtT3V0cHV0ICJOb3RlcGFkKysgaXMgbm90IGluc3RhbGxlZCBvbiB5b3VyIG1hY2hpbmUuIgp9IA==",
"scriptType": "ps"
},
{
"action": "Change Registry Key",
"actionId": "3ffa7131-9c18-4a9e-abe7-7d5338f598c1",
"actionType": "predeploy",
"params": {
"actionItem": "DisableUpdate",
"regKey": "SEtFWV9MT0NBTF9NQUNISU5FXFNPRlRXQVJFXFpvb21cTVNJ",
"regKeyAddNew": false,
"regValue": "dHJ1ZQ==",
"regValueType": "REG_SZ",
"timeout": 180
}
},
{
"action": "System Reboot",
"actionId": "bc4aa991-1e61-4bfc-85ea-ffa389c85e5b",
"actionType": "predeploy",
"params": {
"actionItem": "Reboot",
"timeout": 180
},
"script": "",
"scriptType": "ps"
}
],
"notification": {
"notificationConfigs": {
"completedPercentage": "80",
"recipientEmails": "abc@gmail.com"
},
"notificationEvents": {
"onJobComplete": false,
"onJobStart": true
},
"notificationTypes": {
"email": true
}
},
"postDeployActions": [
{
"action": "Install Software",
"actionId": "adc59f3a-08fd-4fb2-b9cd-906c0f343053",
"actionType": "postdeploy",
"detectionScript": "",
"detectionScriptType": "ps",
"params": {
"actionItem": "Install Notepad with scriptbased option",
"downloadProtocol": 0,
"downloadURL": "https://github.com/notepad-plus-plus/notepad-plus-plus/releases/download/v8.6.2/npp.7.5.8.Installer.exe",
"fileChecksum": "613f36bf5e98be7e56b7ea0c678cfb8534077c2ec1cbe839a854dd0a60278ebb",
"installMethod": 0,
"timeout": 180
},
"script": "JHc2ND1HZXQtSXRlbVByb3BlcnR5IEhLTE06XFNvZnR3YXJlXFdvdzY0MzJOb2RlXE1pY3Jvc29mdFxXaW5kb3dzXEN1cnJlbnRWZXJzaW9uXFVuaW5zdGFsbFwqIHwgd2hlcmUtT2JqZWN0IERpc3BsYXlOYW1lIC1saWtlICdOb3RlUGFkKysqJwokdzMyPUdldC1JdGVtUHJvcGVydHkgSEtMTTpcU29mdHdhcmVcTWljcm9zb2Z0XFdpbmRvd3NcQ3VycmVudFZlcnNpb25cVW5pbnN0YWxsXCogIHwgd2hlcmUtT2JqZWN0IERpc3BsYXlOYW1lIC1saWtlICdOb3RlUGFkKysqJwppZiAoJHc2NCAtb3IgJHczMikKewogICAgV3JpdGUtb3V0cHV0ICJOb3RlcGFkKysgaXMgYWxyZWFkeSBpbnN0YWxsZWQgb24geW91ciBtYWNoaW5lLiIKfQpFbHNlewogICAgV3JpdGUtT3V0cHV0ICJOb3RlcGFkKysgaXMgbm90IGluc3RhbGxlZCBvbiB5b3VyIG1hY2hpbmUuIgp9IA==",
"scriptType": "ps"
},
{
"action": "Uninstall Software",
"actionId": "1d0e3b4d-993f-43ef-83cc-cca1786ede22",
"actionType": "postdeploy",
"params": {
"actionItem": "Uninstall Chrome",
"timeout": 180,
"unInstallRegistryKey": "SEtFWV9MT0NBTF9NQUNISU5FXFNPRlRXQVJFXFdPVzY0MzJOb2RlXE1pY3Jvc29mdFxXaW5kb3dzXEN1cnJlbnRWZXJzaW9uXFVuaW5zdGFsbFxHb29nbGUgQ2hyb21l",
"unInstallSoftwareDisplayName": "Google Chrome",
"unInstallSoftwareVersion": "109.0.5414.168",
"unInstallSoftwareVersionMatch": "Equals"
}
},
{
"action": "Install Software",
"actionId": "900eee9a-ef6a-4d54-ac82-932d8b981935",
"actionType": "postdeploy",
"detectionScript": "",
"detectionScriptType": "ps",
"params": {
"actionItem": "Install Notepad with Installer based option",
"downloadProtocol": 0,
"downloadURL": "https://github.com/notepad-plus-plus/notepad-plus-plus/releases/download/v8.6.2/npp.7.5.8.Installer.exe",
"fileChecksum": "613f36bf5e98be7e56b7ea0c678cfb8534077c2ec1cbe839a854dd0a60278ebb",
"installMethod": 1,
"timeout": 180
},
"script": "",
"scriptType": "ps"
}
],
"applicableAssetCount": 1,
"monthlyRecurringType": null,
"patchTuesdayPlusXDays": null,
"recurringLastDayOfMonth": false,
"jobCategory": 3,
"jobTriggerStatus": 1,
"completionPercent": 100,
"totalAssetCount": 1,
"assetResultReceivedCount": 1,
"jobSource": 3,
"readOnly": false,
"downloadRandomizeTime": 15,
"downloadRandomizeTimeUnit": "MINUTES",
"additionalDynamicPatchesQQL": null,
"additionalDynamicQQLType": null,
"linkedJobId": null,
"linkedJobs": null,
"linkedToJob": null
}