Overview
Scanner API
cURL
Copy
curl -X POST '{backend_url}/admin/workflows-executions/{workflow_id}/run' \
-H 'Authorization: Bearer {jwt_token}'Copy
{
"acknowledgement": {
"workflowId": "<string>",
"transactionId": "<string>",
"hasFinished": true,
"hasFailed": true,
"parentStepIdempotencyKey": "<string>"
}
}Workflows Executions
Execute a Workflow
Execute a workflow by its ID.
POST
/
admin
/
workflows-executions
/
{workflow_id}
/
run
cURL
Copy
curl -X POST '{backend_url}/admin/workflows-executions/{workflow_id}/run' \
-H 'Authorization: Bearer {jwt_token}'Copy
{
"acknowledgement": {
"workflowId": "<string>",
"transactionId": "<string>",
"hasFinished": true,
"hasFailed": true,
"parentStepIdempotencyKey": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The workflow's ID.
Body
application/json
Response
OK
The execution's details.
The workflow's details
Show child attributes
Show child attributes
The ID of the executed workflow.
The ID of the workflow exection's transaction. Use this later to track the workflow execution's progress or succeed / fail its steps.
Whether the workflow execution has finished.
Whether the workflow execution has failed.
The idempotency key of the workflow execution.
⌘I