Get Deployment Job Progress Report

For API version information, refer to the API Version History section.

V1.0

Use this API to generate a Windows and Linux deployment job progress report for the specified job ID.

Note: The API rate limit is 10 requests per hour per customer.

GET/pm/v1/report/jobprogress/{deploymentJobId}

Input ParametersInput Parameters

Parameter	Mandatory/Optional	Data Type	Description
deploymentJobId	Mandatory	string	Specify the required Windows or Linux deployment job ID for which you want to fetch details.
filter	Optional	string	Specify the QQL to filter the job based on search criteria. For example, status: Completed
sort	Optional	string	Sort the jobs by certain data. For example, [{"status":"asc"}]
jobInstanceId	Optional	string	Specify the job instance ID to get the job results report for a particular run of the deployment job. If you don't specify the job instance ID, the job progress report will be generated for the latest job run.
includeActionReport	-	Boolean	Specify whether you want to include deployment actions result in the report. Default value: false

Sample - Get the job progress report for a job IDSample - Get the job progress report for a job ID

API request

    
        curl -X GET 
        "https://gateway.qg2.apps.qualys.com/pm/v1/report/jobprogress/b6fd7a02-1b08-40d0-8504-2bb6bcc36ff8?jobInstanceId=21&includeActionReport=true" -H "accept: application/json" -H "Authorization: Bearer <<jwt token>>"

Response

    
        {
    "reportId": "88f44569-38f1-441a-becc-7749b4c88d9a"
}

V2.0

GET/pm/v2/report/jobProgress/{deploymentJobId}

The Get Deployment Job Progress API has been enhanced to allow you to generate a customized patch report by providing only the required columns for the specified job ID. All columns are selected by default, but you can modify and provide only the required columns. This API supports only Windows and Linux platforms.

Note: For the specified job ID, if you provide an empty request body and null parameters, it will generate a job progress report excluding the action columns. If you add only the includeActionReport: true parameter, the API will generate a report with deployment action result.

Sample - Get Deployment Job Progress ReportSample - Get Deployment Job Progress Report

API Request

curl -X 'POST' \
  '<qualys_base_url>/pm/v2/report/jobprogress/c98a5a66-829e-4f2c-975c-837b1f639cfa' \
  -H 'accept: application/json' 
  -H 'Authorization: Bearer <JWT_Token>
  -H 'Content-Type: application/json' 
  -d

API Body

'{
  "name": "Job Progress Report",
  "description": "Job Progress Report Description",
  "query": "job.asset.status:Completed",
  "includeActionReport": true,
  "jobInstanceId": 1,
  "columnsToDisplay": {
    "jobProgress": [
       "rowId",
      "assetId",
      "assetName",
      "status",
      "pendingInRebootJobName",
      "scanDateTime",
      "operatingSystem",
      "patchStatusType",
      "patchId",
      "title",
      "category",
      "severity",
      "bulletin",
      "kb",
      "qid",
      "cve",
      "reason",
      "reasonCode",
      "osStatus",
      "exitCode",
      "httpStatus",
      "patchInstallDate",
      "assetIp",
      "patchStatusReason",
      "reasonId"
    ],
    "jobProgressActions": [
      "rowId",
      "assetId",
      "assetName",
      "status",
      "pendingInRebootJobName",
      "scanDateTime",
      "operatingSystem",
      "action",
      "actionId",
      "actionType",
      "actionParams",
      "returnCode",
      "errorMessage"
    ]
  }
}'

API Response

{
  "reportId": "dad52003-0fdb-4742-9fcb-8e3931f37035"
}

API Version History

API Version	API Status	Release Date
/pm/v1/report/asset	To be deprecated	July 2026
/pm/v2/report/asset	Active	October 2025

Last updated: November, 2025