Workflow Execution Step List API
Use this API to get a list of all steps executed within a specific workflow run. This includes basic metadata such as step names, statuses, and execution order.
Required Permissions
The following permissions are needed to get the workflow execution step list.
- READ ALL
- READ WF BY TAGS
- READ MY
- LIST ALL
- LIST WF BY TAGS
- LIST MY
Input ParametersInput Parameters
|
Parameter |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|
|
startAt |
Optional |
Date |
Filters workflows to show only those created on or after a specific start date. For example, The response displays all the workflows that were created after |
|
endAt |
Optional |
Date |
Filters workflows to show only those created on or before a specific end date. For example, The response displays all the workflows that were created before |
|
includeData |
Optional |
Boolean |
When set to true, the API response includes both the input and output data for every node in the workflow execution. |
|
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 1Sample 1
API Request
curl -X GET '<qualys_base_url>/qflowapi/v1/executions/0e72b4a1-abea-45b2-9ae9-91cd87506404/steps' -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer <jwt token>"
Response
{
"total": 6,
"items": [
{
"id": "01JT3585YRG0DHQNS9DNN432X3",
"createdAt": 1746010380248,
"updatedAt": 1746010380248,
"tags": [
"created_by=0ffaf046-768b-79fc-83f6-aa25be52c2a1"
],
"customerId": "54f50897-26f3-c9af-83f9-e71459be70d9",
"eventOrder": 2,
"nodeId": "node-e3a84822-qualysevent",
"execution": "0e72b4a1-abea-45b2-9ae9-91cd87506404",
"nodeType": "qualysevent",
"status": "Success",
"startDate": 1746010380100,
"endDate": 1746010380193,
"details": {
"message": "1 events sent"
},
"parDateKey": "2025-04-30T00:00:00.000Z"
},
{
"id": "01JT359MNDCV83CTYGPP95RB0R",
"createdAt": 1746010428077,
"updatedAt": 1746010428077,
"tags": [
"created_by=0ffaf046-768b-79fc-83f6-aa25be52c2a1"
],
"customerId": "54f50897-26f3-c9af-83f9-e71459be70d9",
"eventOrder": 2,
"nodeId": "node-e3a84822-post-event",
"execution": "0e72b4a1-abea-45b2-9ae9-91cd87506404",
"nodeType": "post-event",
"status": "Success",
"startDate": 1746010427974,
"endDate": 1746010428028,
"details": {
"message": "Success"
},
"parDateKey": "2025-04-30T00:00:00.000Z"
},
{
"id": "01JT359NAD5FJE0S2BXCAK86JR",
"createdAt": 1746010428749,
"updatedAt": 1746010428749,
"tags": [
"created_by=0ffaf046-768b-79fc-83f6-aa25be52c2a1"
],
"customerId": "54f50897-26f3-c9af-83f9-e71459be70d9",
"eventOrder": 2,
"nodeId": "node-e3a84822-post-workflow-trigger",
"execution": "0e72b4a1-abea-45b2-9ae9-91cd87506404",
"nodeType": "post-workflow-trigger",
"status": "Success",
"startDate": 1746010428645,
"endDate": 1746010428707,
"details": {
"message": "Success"
},
"parDateKey": "2025-04-30T00:00:00.000Z"
},
{
"id": "01JT359Q39BZ9946H04WJWS12N",
"createdAt": 1746010430570,
"updatedAt": 1746010430569,
"tags": [
"created_by=0ffaf046-768b-79fc-83f6-aa25be52c2a1"
],
"customerId": "54f50897-26f3-c9af-83f9-e71459be70d9",
"eventOrder": 2,
"nodeId": "node-ea318327-action",
"execution": "0e72b4a1-abea-45b2-9ae9-91cd87506404",
"nodeType": "action",
"status": "Success",
"startDate": 1746010429394,
"endDate": 1746010430521,
"details": {
"message": "2 Instances acted on"
},
"parDateKey": "2025-04-30T00:00:00.000Z"
},
{
"id": "01JT3580ZDJDN1427C44NE56BX",
"createdAt": 1746010375149,
"updatedAt": 1746010375149,
"tags": [
"created_by=0ffaf046-768b-79fc-83f6-aa25be52c2a1"
],
"customerId": "54f50897-26f3-c9af-83f9-e71459be70d9",
"eventOrder": 1,
"nodeId": "trigger",
"execution": "0e72b4a1-abea-45b2-9ae9-91cd87506404",
"nodeType": "trigger",
"status": "Running",
"startDate": 1746010375084,
"endDate": null,
"details": null,
"parDateKey": "2025-04-30T00:00:00.000Z"
},
{
"id": "01JT3583JM731H2TKDHDK8TJHF",
"createdAt": 1746010377813,
"updatedAt": 1746010377813,
"tags": [
"created_by=0ffaf046-768b-79fc-83f6-aa25be52c2a1"
],
"customerId": "54f50897-26f3-c9af-83f9-e71459be70d9",
"eventOrder": 2,
"nodeId": "node-67649155-filter",
"execution": "0e72b4a1-abea-45b2-9ae9-91cd87506404",
"nodeType": "filter",
"status": "Success",
"startDate": 1746010377720,
"endDate": 1746010377729,
"details": {
"message": "2 Instances filtered"
},
"parDateKey": "2025-04-30T00:00:00.000Z"
}
]
}
Sample 2Sample 2
API Request
curl -X GET '<qualys_base_url>/qflowapi/v1/executions/0e72b4a1-abea-45b2-9ae9-91cd87506404/steps?&startAt=2025-03-20T01%3A45%3A36.220Z&order=status' -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer <jwt token>"
Response
{
"total": 2,
"items": [
{
"id": "01JT3585TW8WRMAA0KESY9A0SP",
"createdAt": 1746010380124,
"updatedAt": 1746010380124,
"tags": [
"created_by=0ffaf046-768b-79fc-83f6-aa25be52c2a1"
],
"customerId": "54f50897-26f3-c9af-83f9-e71459be70d9",
"eventOrder": 1,
"nodeId": "node-e3a84822-qualysevent",
"execution": "0e72b4a1-abea-45b2-9ae9-91cd87506404",
"nodeType": "qualysevent",
"status": "Running",
"startDate": 1746010380077,
"endDate": null,
"details": null,
"parDateKey": "2025-04-30T00:00:00.000Z"
},
{
"id": "01JT3586DVKJE6ESFK2DNP15A9",
"createdAt": 1746010380731,
"updatedAt": 1746010380731,
"tags": [
"created_by=0ffaf046-768b-79fc-83f6-aa25be52c2a1"
],
"customerId": "54f50897-26f3-c9af-83f9-e71459be70d9",
"eventOrder": 1,
"nodeId": "node-e3a84822-post-event",
"execution": "0e72b4a1-abea-45b2-9ae9-91cd87506404",
"nodeType": "post-event",
"status": "Running",
"startDate": 1746010380678,
"endDate": null,
"details": null,
"parDateKey": "2025-04-30T00:00:00.000Z"
}
]
}