Get List of Generated Reports

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

V1.0 | V2.0

V1.0

Use this API to fetch a list of recently triggered Windows, Linux, and Mac job progress reports.

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

GET/pm/v1/reports

Input ParametersInput Parameters

Parameter

Mandatory/Optional

Data Type

Description

limit

Optional

string

Specify the number of reports to return.

Default value: 10

Sample - Get a list of recently triggered reportsSample - Get a list of recently triggered reports

API request

    
        curl -X GET 
        "https://<QualysBaseURL>/pm/v1/reports?limit=10" -H "accept: application/json" -H "Authorization: Bearer <<jwt token>>"
    

Response

   
[
{
    "reportId": "84b7e8e4-878d-4506-a8aa-fb7b278648c7",
    "type": "ASSET",
    "createdDate": 1719298145204,
    "expirationDate": 1719902945204,
    "status": 1,
    "queryHavingQuery": null,
    "fileSize": "8.07 KB",
    "platform": "Windows",
    "name": "ASSET",
    "description": "Asset Report_84b7e8e4-878d-4506-a8aa-fb7b278648c7"
  },
{
    "reportId": "703729bf-3551-4bd0-a269-3e0728bc1cf7",
    "type": "JOB_PROGRESS",
    "createdDate": 1719213541633,
    "expirationDate": 1719818341633,
    "status": 1,
    "queryHavingQuery": "(jobId:e3587d7b-6798-492d-8b20-6840a2115fbe AND jobInstanceId:1)",
    "fileSize": "1.85 KB",
    "platform": "Windows",
    "name": "JOB_PROGRESS",
    "description": "Job Progress Report_703729bf-3551-4bd0-a269-3e0728bc1cf7"
  },
 {
    "reportId": "3a5e5951-6d09-482b-9a00-1a214005e716",
    "type": "ASSET",
    "createdDate": 1719206058999,
    "expirationDate": 1719810858999,
    "status": 1,
    "queryHavingQuery": null,
    "fileSize": "8.07 KB",
    "platform": "Windows",
    "name": "ASSET",
    "description": "Asset Report_3a5e5951-6d09-482b-9a00-1a214005e716"
  },
]    

V2.0 

GET/pm/v2/reports

Input ParametersInput Parameters

Parameter

Mandatory/Optional

Data Type

Description

limit

Optional

string

Specify the number of reports to return.

Default value: 20

Sample - Get a list of recently triggered reportsSample - Get a list of recently triggered reports

API request

    
        curl -X GET 
        "https://<QualysBaseURL>/pm/v2/reports?limit=20" -H "accept: application/json" -H "Authorization: Bearer <<jwt token>>"
    

Response

   
[
{
    "reportId": "84b7e8e4-878d-4506-a8aa-fb7b278648c7",
    "type": "ASSET",
    "createdDate": 1719298145204,
    "expirationDate": 1719902945204,
    "status": 1,
    "queryHavingQuery": null,
    "fileSize": "8.07 KB",
    "platform": "Windows",
    "name": "ASSET",
    "description": "Asset Report_84b7e8e4-878d-4506-a8aa-fb7b278648c7"
  },
{
    "reportId": "703729bf-3551-4bd0-a269-3e0728bc1cf7",
    "type": "JOB_PROGRESS",
    "createdDate": 1719213541633,
    "expirationDate": 1719818341633,
    "status": 1,
    "queryHavingQuery": "(jobId:e3587d7b-6798-492d-8b20-6840a2115fbe AND jobInstanceId:1)",
    "fileSize": "1.85 KB",
    "platform": "Windows",
    "name": "JOB_PROGRESS",
    "description": "Job Progress Report_703729bf-3551-4bd0-a269-3e0728bc1cf7"
  },
 {
    "reportId": "3a5e5951-6d09-482b-9a00-1a214005e716",
    "type": "ASSET",
    "createdDate": 1719206058999,
    "expirationDate": 1719810858999,
    "status": 1,
    "queryHavingQuery": null,
    "fileSize": "8.07 KB",
    "platform": "Windows",
    "name": "ASSET",
    "description": "Asset Report_3a5e5951-6d09-482b-9a00-1a214005e716"
  },
]    


API Version History

The following table depicts the information about the different versions of this API along with the status:

API Version API Status Release Date
/pm/v2/reports Active Oct 2024
/pm/v1/reports To be deprecated Jan 2024