Get Deployment by Job ID

Use this API to get details of the deployment job based on the provided deployment job ID.

GET/pm/v1/deploymentjob/{deploymentJobId}

Input ParametersInput Parameters

Parameter

Mandatory/Optional

Data Type

Description

deploymentJobId

Mandatory

string

Deployment job ID for which you want to fetch details.

Sample - Get details for a job using the job IDSample - Get details for a job using the job ID

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": "Test pre-post_2",
    "type": "Install",
    "status": "Completed",
    "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": "",
    "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": "Change Registry Key",
            "actionId": "0ffc4ac7-9b68-49f0-805f-5ec187421d06",
            "actionType": "predeploy",
            "params": {
                "actionItem": "abc",
                "regKey": "SEtMTS9zb2Z0d2FyZS9zYWdhcg==",
                "regValueType": "REG_BINARY",
                "regValue": "MA==",
                "regKeyAddNew": true
            }
        },
        {
            "action": "Run Script",
            "actionId": "76a7b38c-19be-47c7-88a6-22d5f3325f9c",
            "actionType": "predeploy",
            "params": {
                "actionItem": "S1"
            },
            "script": "bHMgLWFs",
            "scriptType": "ps"
        }
    ],
    "postDeployActions": null,
    "applicableAssetCount": 1,
    "monthlyRecurringType": null,
    "patchTuesdayPlusXDays": null,
    "recurringLastDayOfMonth": false,
    "jobCategory": 3,
    "jobTriggerStatus": 1,
    "completionPercent": 100,
    "totalAssetCount": 1,
    "assetResultReceivedCount": 1,
    "jobSource": 2,
    "readOnly": false
}