Get a List of All Deployment Jobs

Use this API to get a list of deployment jobs in your subscription.

GET/pm/v1/deploymentjobs/summary

Input ParametersInput Parameters

Parameter	Mandatory/Optional	Data Type	Description
attributes	Optional	string	From all attributes, specify comma-separated string of attributes that you want to fetch in the response.
coauthorJob	Optional	boolean	Specify the co-author for the deployment. Default value: false
filter	Optional	string	Specify the QQL to filter jobs based on deployment jobs search criteria. For example, status:Completed
ownedJob	Optional	boolean	Get the jobs that are owned by you. Default value: false
pageNumber	Optional	string	The page to be returned. Default value: 0
pageSize	Optional	string	Limit number of rows to be returned per page. Default value: 10
platform	Optional	string	The platform type. - Available values: Linux, Windows - Default value: Windows
sort	Optional	string	Sort the job list by certain data. For example, [{"status":"asc"}]

Sample - Get all deployment jobs in your subscriptionSample - Get all deployment jobs in your subscription

API request

    
     curl -X GET 
     "https://<QualysBaseURL>/pm/v1/deploymentjobs/summary?attributes=id%2C%20name%2C%20type&coauthorJob=false&filter=isRecurring%3A%20true&ownedJob=false&pageNumber=0&pageSize=2&platform=Windows&sort=%5B%7B%22status%22%3A%22asc%22%7D%5D" -H "accept: application/json" -H "Authorization: Bearer <<jwt token>>"

Response

    
   [
  {
    "coAuthorUserIds": [],
    "timezone": "UTC",
    "exclusionFilterType": "Any",
    "dynamicQQLType": null,
    "matchAllTags": null,
    "type": "Install",
    "nextScheduleDateTime": null,
    "platform": "Windows",
    "assets": [],
    "recurringWeekDays": null,
    "customerId": "bc023fd7-4290-f28f-8181-95a46f519f52",
    "exclusionTags": [],
    "isDynamicPatchesQQL": null,
    "taggedAssetCount": 0,
    "patchCount": 2,
    "id": "0b22333c-8cf1-4210-b6c5-fec6e2df2497",
    "assetCount": null,
    "applicableAssetCount": 0,
    "patchTuesdayPlusXDays": null,
    "schemaVersion": "1.0",
    "recurringLastDayOfMonth": null,
    "linkedJobReferenceCount": 0,
    "created": {
      "date": 1706159019827,
      "user": {
        "name": "quays_rw17",
        "id": "c4c71f94-4ef6-7e6f-8260-11704fa58172"
      }
    },
    "triggerStatus": 0,
    "patches": [
      {
        "id": "ca0d50b1-df21-31ef-aa9b-eec805b3a517",
        "title": "Opera 83.0.4254.62"
      },
      {
        "id": "9285e676-6340-3ba7-b124-31d84542c7bf",
        "title": "BlueJeans 2.33.1119.0"
      }
    ],
    "recurringDayOfMonth": null,
    "recurringWeekDayOfMonth": null,
    "jobSource": 3,
    "isRecurring": false,
    "lastScheduleDateTime": null,
    "readOnly": false,
    "tags": [],
    "exclusionAssetIds": [],
    "dynamicPatchesQQL": null,
    "startDateTime": "2024-1-25 05:03:39 AM",
    "timezoneType": "SPECIFIC_TZ",
    "deleted": false,
    "scheduleType": "On-demand",
    "monthlyRecurringType": 0,
    "dayOfMonth": null,
    "name": "Public API on demand Window job with specific patches",
    "disabledPatches": null,
    "filterType": "Any",
    "category": 3,
    "updated": null,
    "additionalQQLS": [],
    "status": "Disabled",
    "linkedJobId": null
  }
]