Get a List of Deployment Jobs that can be Used to Fetch Patches From

Use this API to get a list of deployment jobs that you can use to fetch patches from.

GET/pm/v1/deploymentjobs/availableToLink

Input ParametersInput Parameters

Parameter

Mandatory/Optional

Data Type

Description

filter

Optional

string

Specify a QQL to filter jobs based on deployment job search criteria.

For example, scheduleType:'Daily'.

pageNumber

Optional

string

Specify the page to be returned. The page numbers start from 0.

Default value: 0

pageSize

Optional

string

Specify the number of rows to be shown per page.

Default value: 10

platform

Optional

string

Specify the platform type.

Available values: Linux, Windows

Default value: Windows

sort

Optional

string

Specify sorting field.

For example, [{"name":"asc"}].

Sample - Get a list of deployment jobs that you can use to fetch patches fromSample - Get a list of deployment jobs that you can use to fetch patches from

API request

      curl -X GET 
"https://<QualysBaseURL>/pm/v1/deploymentjobs/availableToLink?filter=scheduleType%3A%27Daily%27&pageNumber=0&pageSize=5&platform=Windows&sort=%5B%7B%22name%22%3A%22asc%22%7D%5D" -H "accept: application/json" -H "Authorization: Bearer <<Jwt Token>>" 

Response

    [
    {
        "customerId": "bc023fd7-4290-f28f-8181-95a46f519f52",
        "id": "d1edbd66-cde0-4d7e-b716-32a8a04e958f",
        "name": "PUBLIC API JOB",
        "type": "Install",
        "status": "Preparing",
        "createdBy": {
            "user": {
                "id": "c4c71f94-4ef6-7e6f-8260-11704fa58172",
                "name": "quays_rw17"
            },
            "date": 1663741360890
        },
        "linkedJobReferenceCount": null,
        "schedule": "Daily, 03:15 PM",
        "previousRun": null,
        "nextRun": null
    },
    {
        "customerId": "bc023fd7-4290-f28f-8181-95a46f519f52",
        "id": "f52df438-b22f-4593-b860-d1ca0044be76",
        "name": "Public Api (Daily Job)",
        "type": "Install",
        "status": "Preparing",
        "createdBy": {
            "user": {
                "id": "c4c71f94-4ef6-7e6f-8260-11704fa58172",
                "name": "quays_rw17"
            },
            "date": 1664348215430
        },
        "linkedJobReferenceCount": null,
        "schedule": "Daily, 03:15 PM",
        "previousRun": null,
        "nextRun": null
    }
]