Workflow Details API
Use this API to get detailed metadata and configuration information for a specific workflow. It’s useful for understanding the purpose, structure, and requirements of a workflow before running or modifying it.
Required Permissions
The following permissions are needed to get the workflow details.
- READ ALL
- READ WF BY TAGS
- READ MY
Input ParametersInput Parameters
|
Parameter |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|
|
workflowId |
Mandatory |
String |
Provide a valid workflow ID. Ensure it is UUID. For example, '0ffaf046-768b-79fc-83f6-aa25be52c2a1'. |
|
Authorization |
Mandatory |
String |
Authorization token to authenticate to the Qualys Cloud Platform. Prepend token with 'Bearer' and one space. For example - Bearer <authToken> |
Sample: Get the details of a workflowsSample: Get the details of a workflows
API Request
curl -X POST '<qualys_base_url>/qflowapi/v1/workflows/f516bcf4-f6fb-46ac-a54f-ddbcf2a2d24a' -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer <jwt token>"
Response
{
"data":{
"id":"f516bcf4-f6fb-46ac-a54f-ddbcf2a2d24a",
"createdAt":1744786878828,
"updatedAt":1747114432724,
"tags":[
"created_by=0ffaf046-768b-79fc-83f6-aa25be52c2a1"
],
"workflow":"f516bcf4-f6fb-46ac-a54f-ddbcf2a2d24a",
"revision":"27653453ffa1beb74ce8d1aaabc55162377c4090ac14e3441fc900c798891ee2",
"definition":"{\"variables\":[{\"key\":\"region\",\"value\":[\"us-east-1\"]},{\"key\":\"resourceGroup\",\"value\":[]},{\"key\":\"project\",\"value\":[]},{\"key\":\"credentials\",\"value\":[\"@aa70acae-6ea8-3acf-b504-f327855b316a\"]},{\"key\":\"credentials_azure\",\"value\":[]},{\"key\":\"credentials_gcp\",\"value\":[]}],\"components\":[{\"name\":\"Trigger\",\"id\":\"trigger\",\"type\":\"trigger\",\"next\":\"node-6748e0e3-resource\",\"previous\":null,\"inputs\":{\"event\":{\"active\":false,\"value\":{\"pattern\":{},\"cloudProvider\":\"\",\"selectedServiceName\":\"\",\"selectedEventsName\":\"\",\"selectedFilters\":[{\"values\":[\"\"],\"key\":\"\"}],\"patternCheck\":{},\"selectedEventsFiltersState\":[]}},\"cloudview\":{\"active\":false},\"schedule\":{\"active\":false,\"value\":[]}},\"target\":{\"script\":\"trigger\"},\"selectedResource\":null,\"conditionalSettings\":{\"conditions\":[],\"expression\":\"\"},\"advanceOptions\":{}},{\"name\":\"AWS Resource\",\"id\":\"node-6748e0e3-resource\",\"type\":\"resource\",\"next\":\"node-67649155-filter\",\"previous\":\"trigger\",\"inputs\":{\"resourceType\":\"EC2_INSTANCE\",\"service\":\"EC2\",\"method\":\"describeInstances\",\"params\":{\"Filters\":[{\"Name\":\" \",\"Values\":[\" \",\" \"]}],\"InstanceIds\":[\" \",\" \"],\"MaxResults\":\" \",\"NextToken\":\" \"},\"addOns\":[]},\"target\":{\"script\":\"awsapi\"},\"selectedResource\":null,\"conditionalSettings\":{\"conditions\":[],\"expression\":\"\"},\"advanceOptions\":{\"disablePagination\":false}},{\"name\":\"Filter\",\"id\":\"node-67649155-filter\",\"type\":\"filter\",\"next\":\"node-e3a84822-action\",\"previous\":\"node-6748e0e3-resource\",\"inputs\":{\"conditions\":[{\"id\":\"c1\",\"type\":\"tag\",\"key\":\"stop-instance\",\"value\":\"true\",\"operator\":\"has\"}],\"expression\":\"( (c1) )\"},\"target\":{\"script\":\"customFilter\"},\"selectedResource\":{\"label\":\"AWSResource.Instances\",\"selectedResourceId\":\"node-6748e0e3-resource\",\"path\":\"\",\"context\":{\"outputPath\":\"\"}},\"conditionalSettings\":{\"conditions\":[],\"expression\":\"\"},\"advanceOptions\":{}},{\"name\":\"AWS Action\",\"id\":\"node-e3a84822-action\",\"type\":\"action\",\"next\":\"node-ea318327-action\",\"previous\":\"node-67649155-filter\",\"inputs\":{\"service\":\"EC2\",\"resourceType\":\"EC2_INSTANCE\",\"method\":\"stopInstances\",\"params\":{\"InstanceIds\":[\"obj.InstanceId\"],\"Hibernate\":\" \",\"Force\":\" \"},\"waitForAction\":\"true\"},\"target\":{\"script\":\"awsapi\"},\"selectedResource\":{\"selectedResourceId\":\"node-67649155-filter\",\"path\":\"\",\"label\":\"Filter.Instances\",\"context\":{\"outputPath\":\"\"}},\"conditionalSettings\":{\"conditions\":[],\"expression\":\"\"},\"advanceOptions\":{}},{\"name\":\"AWS Action (2)\",\"id\":\"node-ea318327-action\",\"type\":\"action\",\"next\":null,\"previous\":\"node-e3a84822-action\",\"inputs\":{\"service\":\"EC2\",\"resourceType\":\"EC2_SNAPSHOT\",\"method\":\"createSnapshots\",\"params\":{\"InstanceSpecification\":{\"InstanceId\":\"obj.InstanceId\",\"ExcludeDataVolumeIds\":[\" \",\" \"],\"ExcludeBootVolume\":\" \"},\"Description\":\" e.g: Created By TC for createSnapshots On DATE\",\"OutpostArn\":\" \",\"CopyTagsFromSource\":\" \",\"TagSpecifications\":[{\"ResourceType\":\" \",\"Tags\":[{\"Key\":\" \",\"Value\":\" \"}]}]},\"waitForAction\":\"false\"},\"target\":{\"script\":\"awsapi\"},\"selectedResource\":{\"selectedResourceId\":\"node-67649155-filter\",\"path\":\"\",\"label\":\"Filter.Instances\",\"context\":{\"outputPath\":\"\"}},\"conditionalSettings\":{\"conditions\":[],\"expression\":\"\"},\"advanceOptions\":{}}]}",
"deletedAt":null,
"customerId":"54f50897-26f3-c9af-83f9-e71459be70d9",
"name":"aws-action-node",
"description":" ",
"state":null,
"active":true,
"properties":{
"priority":1,
"severity":1,
"categories":{
"services":[
],
"accounts":[
"aa70acae-6ea8-3acf-b504-f327855b316a"
],
"regions":[
"us-east-1"
],
"resource_groups":[
],
"projects":[
],
"solutions":[
"AWS Best Practices"
],
"apps":[
],
"cloud_providers":[
"AWS"
]
},
"editorVersion":"2.0",
"hidden":false
},
"last_execution_details":{
"message":"connect ECONNREFUSED 10.238.62.201:8090",
"executionEndDate":1747114432510
},
"last_execution_status":"Error",
"type":"normal"
}
}