Qualys Flow Release 1.19 API

September 26, 2025

Run Workflow API

New or Updated API

Updated

API Endpoint

/qflowapi/v1/workflows/{workflowId}/run

Method

POST

DTD or XSD changes

Not Applicable

Use this API to initiate the execution of a specific workflow. It allows triggering automated processes with input parameters.

With this release, we have updated the supported variables for the input parameter.

We have consolidated all the cloud provider Connector ID variables into a single variable named connectorId. The connectorId variable replaces the credentials/credentials_azure/credentials_gcp variables introduced in QFlow 1.18.

You can continue to use the individual credentials/credentials_azure/credentials_gcp variables, but the connectorId parameter shall have precedence if both are passed in the request. 

We have also introduced OCI connector values in the supported variables in accordance with QFlow 1.19's introduction of OCI Nodes. Now, you can pass OCI connectorId and OCI region in your Run Workflow API Request. 

Input ParametersInput Parameters

Parameter

Mandatory/Optional

Data Type

Description

workflowId

Mandatory

 String

Unique identifier of the workflow to run.

input Optional  String Workflow-specific input parameters. Example: {"buckets": ["test-bucket-1", "test-bucket-2"]}

variables

Optional

String

Key-value pairs to override workflow variables at runtime. See the table below for supported system and user-defined variables.

Variables Updated

Name Connector Type Type Example Value Description
connectorId AWS, Azure, GCP, OCI string (UUID) aa70acae-xxxx-xxxx-xxxx-f327855b316a Connector used for authentication.
region AWS string us-east-1 AWS region for deployment.
resourceGroup Azure string DefaultResourceGroup-CIN Azure resource group name.
project GCP string gcp-qualys-demo GCP project ID.
oci_region OCI string ap-hyderabad-1 OCI region ID
compartment OCI string ocid1.compartment.oc1..aaaaaaaadrxxxxxxxxx

The OCI Compartment ID.

Sample: Initiate execution of a workflow Sample: Initiate execution of a workflow 

API Request

curl --location 'https://<qualys_base_url>.qualys.com/qflowapi/v1/workflows/6cad21c8-4405-4517-beb9-7372feafb5b4/run' \
--header 'accept: application/json' \
--header 'Authorization: <Token>' \
--header 'Content-Type: application/json' \
--data '{   
    "input": {
        "bucketName": "test-bucket-1",
        "totalBucketCount": 4
    },
    "variables":{
        "connectorId": "aa70acae-xxxx-xxxx-xxxx-f327855b316a",
        "region": "us-east-1",
        "name": "maha2"
    }
}'

Response

{
    "message": "Workflow execution started",
    "executionId": "497d0fe7-xxxx-xxxx-xxxx-3d90e904d1c5"
}