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

    
       [
    {
        "type": "Install",
        "id": "ee9bf4ab-1f8f-4bdc-affc-d3cf4b763911",
        "name": "Test for manifest 1.4.6.0"
    },
    {
        "type": "Install",
        "id": "e6a594ce-9590-4880-9aac-b29131cc3a5e",
        "name": "Copy_of_Explicit 4"
    }
]