Get Deployment Job List

Use this API to get a detailed list of deployment jobs created by you or for which you are a co-author.

GET/pm/v1/deploymentjobs

Input ParametersInput Parameters

Parameter	Mandatory/Optional	Data Type	Description
attributes	Optional	string	From all attributes, specify a 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 patch values by certain data. For example, [{"status":"asc"}]

Sample - Get a list of deployment job in your scopeSample - Get a list of deployment job in your scope

API request

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

Response

    
     [
    {
        "type": "Install",
        "id": "1b8fef71-ff29-4bad-bbde-d36e90099962",
        "name": "Test job for sync"
    },
    {
        "type": "Install",
        "id": "42ad866e-f009-4882-bc3d-2ebb99ff04ad",
        "name": "Fwade"
    },
    {
        "type": "Install",
        "id": "cc452752-78a0-4f58-ac15-7baf4b68d447",
        "name": "windows job "
    },
    {
        "type": "Install",
        "id": "114e5a27-1a57-4ef6-a90e-704947b7efef",
        "name": "Copy_of_Test for manifest 1.4.6.0_1632401273733"
    },
    {
        "type": "Install",
        "id": "24156d6d-9aff-4bf6-b37e-6345012c4b9f",
        "name": "Beast2"
    }
]