Workflow List API

GET/qflowapi/v1/workflows

Use this API to get a comprehensive list of all available workflows. It helps users identify which workflows are accessible for execution. It allows pagination of results. It supports filtering by a Qualys Query Language (QQL) token, date range (start date to end date).

Required Permissions

The following permissions are needed to get the workflow list.

LIST ALL
LIST WF BY TAGS
LIST MY

Input ParametersInput Parameters

Parameter	Mandatory/Optional	Data Type	Description
pageSize	Mandatory	Integer	The number of records per page to be included in the response.
pageNumber	Mandatory	Integer	The page to be returned. Starts from 1.
query	Optional	String	QQL Query to filter the reponse as per query. `qflow.name: Publicly accessible RDS DB Instances` The response displays all the workflows that match the criteria in the query.
startAt	Optional	Date	Filters workflows to show only those created on or after a specific start date. For example, `startAt: "2024-10-15T00:00:00Z"` The response displays all the workflows that were created after `2024-10-15T00:00:00Z.`
endAt	Optional	Date	Filters workflows to show only those created on or before a specific end date. For example, `endAt: "2024-10-25T23:59:59Z"` The response displays all the workflows that were created before `2024-10-25T00:00:00Z.`
order	Optional	String	Specifies the field to sort the results. Use the field name as is for ascending order, or prefix it with a hyphen (-) to sort in descending order.
Authorization	Mandatory	String	Authorization token to authenticate to the Qualys Cloud Platform. Prepend token with 'Bearer' and one space. For example - Bearer <authToken>

Sample 1: Get the workflows with page size 1 Sample 1: Get the workflows with page size 1

API Request

curl -X GET
'<qualys_base_url>/qflowapi/v1/workflows?pageSize=1&pageNumber=1''
-H "Accept: application/json"
-H "Content-Type: application/json"
-H "Authorization: Bearer <jwt token>"

Response

{
    "total":"3299",
    "items":[
        {
            "workflow":"e835a944-e8b2-4f34-8b42-46369751f025",
            "description":"Created by automated testing",
            "active":false,
            "last_execution_details":{
                "executionEndDate":1650876554876,
                "message":"Failed to access resource, Please verify IAM access key, role has enough permission"
            },
            "tags":[
                "created_by=0ffaf046-768b-79fc-83f6-aa25be52c2a1"
            ],
            "revision":"2da8280780247c0ac75407abe604e41f0cfa0defe28d5313f8673ae8def97a4b",
            "createdAt":1650876525910,
            "deletedAt":"2022-04-25T08:49:27.362Z",
            "last_execution_status":"Error",
            "customerId":"54f50897-26f3-c9af-83f9-e71459be70d9",
            "name":"automated_test_7480",
            "id":"ffdb6a3e-bb29-472d-b1a8-021d034283f2",
            "state":null,
            "properties":{
                "severity":1,
                "hidden":false,
                "categories":{
                    "regions":[
                        "us-east-1"
                    ],
                    "solutions":[
                        "Auto Remediation"
                    ],
                    "cloud_providers":[
                        "AWS"
                    ],
                    "services":[
                        
                    ],
                    "accounts":[
                        "93ff70fa-22be-4ab7-b78a-0bcab3367ff2"
                    ],
                    "apps":[
                        
                    ]
                },
                "priority":1
            },
            "updatedAt":1650876545996
        }
    ]
}

Sample 2: Get the list of workflows created before an end dateSample 2: Get the list of workflows created before an end date

API Request

curl -X GET
'<qualys_base_url>/qflowapi/v1/workflows?pageSize=2&pageNumber=1&query=qflow.status%3ASuccess&endAt=2025-05-12T01%3A45%3A36.220Z&startAt=2025-01-20T01%3A45%3A36.220Z'
-H "Accept: application/json"
-H "Content-Type: application/json"
-H "Authorization: Bearer <jwt token>"

Response

 {
    "total": "1",
    "items": [
        {
            "workflow": "0e639f8f-5145-4bf3-ba22-a6d32848dbe3",
            "description": " ",
            "active": false,
            "last_execution_details": {
                "executionEndDate": 1744178134776
            },
            "type": "normal",
            "tags": [
                "created_by=0ffaf046-768b-79fc-83f6-aa25be52c2a1"
            ],
            "revision": "a992911a741a93573c6438c9b562ddcb7e77be3999b11a86dccc0af377fdd431",
            "createdAt": 1744178124823,
            "deletedAt": null,
            "last_execution_status": "Success",
            "customerId": "54f50897-26f3-c9af-83f9-e71459be70d9",
            "name": "Amit Test Custom",
            "id": "0e639f8f-5145-4bf3-ba22-a6d32848dbe3",
            "state": null,
            "properties": {
                "severity": 1,
                "editorVersion": "2.0",
                "hidden": false,
                "categories": {
                    "regions": [],
                    "projects": [],
                    "solutions": [
                        "AWS CIS"
                    ],
                    "cloud_providers": [],
                    "services": [],
                    "accounts": [],
                    "resource_groups": [],
                    "apps": []
                },
                "priority": 1
            },
            "updatedAt": 1744178134830
        }
    ]
}