List Project Files API

GET/ot/v1/projectfile/list

Use this API function to retrieve a list of the project files that are collected from programming and maintenance software in your network. The response has project files details and related assets, status, the extension of the file and so on. If the total count exceeds the number of results returned, you can fetch the next page by calling the API again with the next page number.

Input ParametersInput Parameters

Parameter	Mandatory/Optional	Data Type	Description
filter	Optional	String	Filter the events list by providing a query using Qualys syntax. Refer to the Tokens Supported for List Project Files API for assistance with creating your query.
pageNumber	Optional	Integer	The page to be returned. Starts from zero.
pageSize	Optional	Integer	Provide the number of records per page to be included in the response. Default: 0 Maximum: 100 For example, the total result set is 50 files. If the page size is specified as 10, then the result is divided into 5 pages with 10 files on each page.
sort	Optional	String	Sort the results using a Qualys Search token. By default, the result is sorted by [{"lastUpdated":"dec"}]
Authorization	Mandatory	String	Authorization token to authenticate to the Qualys Cloud Platform. Prepend token with "Bearer" and one space. For example - Bearer <authToken>

Sample with a FilterSample with a Filter

The following sample request specifies page size as 10, the request fetches all project files related to vendor Siemens. The response has project files details and related assets, status, extension of the file and so on.

API Request

curl -X 'GET' \
'https://<qualys_base_url>/ot/v1/projectfile/list?filter=vendor%20%3A%20%22Siemens%22&pageNumber=0&pageSize=10'\
-H 'accept: application/json' \
-H 'Authorization: Bearer <jwt token>' \

Response Headers

cache-control: no-cache,no-store,max-age=0,must-revalidate 
content-encoding: gzip 
content-type: application/json 
count: 10 
date: Wed,12 Apr 2023 09: 37: 34 GMT 
expires: 0 
pragma: no-cache 
referrer-policy: no-referrer 
transfer-encoding: chunked 
vary: accept-encoding 
x-content-type-options: nosniff 
x-frame-options: DENY 
x-ratelimit-limit: 300 
x-ratelimit-remaining: 298 
x-ratelimit-window-sec: 3600 
x-xss-protection: 1 ; mode=block

Note: The count header shows the total number of records available in the response.

Response

[
    {
        "name": "Devices_Profinet_Mod",
        "extension": ".dz5",
        "status": "Imported",
        "plantLocation": "1",
        "vendor": "Siemens",
        "assetCount": 9,
        "engineeringToolName": "DIGSI 5",
        "engineeringToolVersion": "08.804",
        "fileHash": "54ac68844e620996295604b3aab61cc0",
        "uploadedBy": "User John",
        "lastUpdated": "2023-03-09T11:06:15.351Z"
    },
    {
        "name": "Protection_Relay",
        "extension": ".dz5",
        "status": "Deleted",
        "plantLocation": "1",
        "vendor": "Siemens",
        "assetCount": 0,
        "engineeringToolName": "DIGSI 5",
        "engineeringToolVersion": "08.804",
        "fileHash": "98adf9cc489967cb5d5151f472cb7518",
        "uploadedBy": "User John",
        "lastUpdated": "2023-03-09T11:05:07.800Z"
    },
    {
        "name": "s7_400_pc",
        "extension": ".cfg",
        "status": "Imported",
        "plantLocation": "2",
        "vendor": "Siemens",
        "assetCount": 2,
        "engineeringToolName": "STEP7",
        "engineeringToolVersion": "V5.6 + HF1",
        "fileHash": "3af85c535ea32f98e288b4a871aa5b80",
        "uploadedBy": "User John",
        "lastUpdated": "2023-03-09T10:59:34.578Z"
    },
    {
        "name": "Standalone_Device",
        "extension": ".dz5",
        "status": "Importing",
        "plantLocation": "test",
        "vendor": "Siemens",
        "assetCount": 0,
        "engineeringToolName": "DIGSI 5",
        "engineeringToolVersion": "08.804",
        "fileHash": "f4498d9c23fd1d2038e68d6f0e77ab8e",
        "uploadedBy": "User John",
        "lastUpdated": "2023-03-09T10:26:24.959Z"
    },
    {
        "name": "s7_400_pc",
        "extension": ".cfg",
        "status": "Deleted",
        "plantLocation": "1",
        "vendor": "Siemens",
        "assetCount": 0,
        "engineeringToolName": "STEP7",
        "engineeringToolVersion": "V5.6 + HF1",
        "fileHash": "3af85c535ea32f98e288b4a871aa5b80",
        "uploadedBy": "User John",
        "lastUpdated": "2023-02-01T06:12:42.430Z"
    },
    {
        "name": "s7_400_pc",
        "extension": ".cfg",
        "status": "Deleted",
        "plantLocation": "2",
        "vendor": "Siemens",
        "assetCount": 2,
        "engineeringToolName": "STEP7",
        "engineeringToolVersion": "V5.6 + HF1",
        "fileHash": "3af85c535ea32f98e288b4a871aa5b80",
        "uploadedBy": "User John",
        "lastUpdated": "2023-02-01T06:00:24.887Z"
    },
    {
        "name": "s7_400_pc",
        "extension": ".cfg",
        "status": "Deleted",
        "plantLocation": "2",
        "vendor": "Siemens",
        "assetCount": 0,
        "engineeringToolName": "STEP7",
        "engineeringToolVersion": "V5.6 + HF1",
        "fileHash": "3af85c535ea32f98e288b4a871aa5b80",
        "uploadedBy": "User John",
        "lastUpdated": "2023-02-01T06:00:24.887Z"
    },
]