Run Workflow API

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

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

Required Permissions

Following permissions are needed to run the workflow:

EXECUTE ALL
EXECUTE WF BY TAGS
EXECUTE MY WF

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'
Request Body	Optional	JSON	Provide a valid JSON object containing the input data to run the workflow. For example, { "information": "some important data" }
Authorization	Mandatory	String	Authorization token to authenticate to the Qualys Cloud Platform. Prepend token with 'Bearer' and one space. For example - Bearer <authToken>

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'

Request Body

Optional

JSON

Provide a valid JSON object containing the input data to run the workflow.

For example,

{
"information": "some important data"
}

Authorization

Mandatory

String

Authorization token to authenticate to the Qualys Cloud Platform.

Prepend token with 'Bearer' and one space.

For example - Bearer <authToken>

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

API Request

curl -X POST
'<qualys_base_url>/qflowapi/v1/workflows/f516bcf4-f6fb-46ac-a54f-ddbcf2a2d24a/run'
-H "Accept: application/json"
-H "Content-Type: application/json" 
-H "Authorization: Bearer <jwt token>"

Response

{
    "data":{
        "customerId":"54f50897-26f3-c9af-83f9-e71459be70d9",
        "workflowId":"f516bcf4-f6fb-46ac-a54f-ddbcf2a2d24a",
        "input":{
            
        },
        "executionId":"ee75301e-bbcf-4e7e-9cae-b6f99fc2060e",
        "forceRun":true,
        "overrideVariables":[
            
        ],
        "source":"PUBLIC_API"
    }
}