Updating a Workflow

Function

This API is used to update a workflow.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/soc/workflows/{workflow_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A
workspace_id	Yes	String	Definition Workspace ID. Range N/A
workflow_id	Yes	String	Definition Workflow ID. Range N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A
content-type	Yes	String	Definition Content type. application/json;charset=UTF-8: common API request type Constraints N/A Range application/json;charset=UTF-8 Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	No	String	Definition Workflow name. Constraints N/A Range N/A Default Value N/A
description	No	String	Definition Workflow description. Constraints N/A Range N/A Default Value N/A
enabled	No	Boolean	Definition Whether to enable or disable a workflow. Constraints N/A Range true: The workflow will be enabled. false: The workflow will be disabled. Default Value N/A
version_id	No	String	Definition Workflow version ID. Constraints ID of the activated workflow version in the current workflow. This parameter is mandatory when the workflow is enabled.
labels	No	String	Definition Workflow entity type. IP: IP address ACCOUNT: account DOMAIN: domain name Constraints N/A Range IP ACCOUNT DOMAIN Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
code	String	Definition Error code. Range N/A
message	String	Definition Error description. Range N/A
success	Boolean	Definition Whether the request is successful. Range true: successful false: failed
request_id	String	Definition Request ID. Constraints N/A
data	AopWorkflowInfo object	Workflow details.

**Table 5** AopWorkflowInfo
Parameter	Type	Description
id	String	Definition Workflow ID. Range N/A
name	String	Definition Workflow name. Range N/A
description	String	Definition Workflow description. Range N/A
project_id	String	Definition Tenant ID. Range N/A
owner_id	String	Definition Owner ID. Range N/A
creator_id	String	Definition Creator ID. Range N/A
creator_name	String	Definition Name of the creator. Range N/A
create_time	String	Definition Creation time. Range N/A
modifier_id	String	Definition ID of the updater. Range N/A
modifier_name	String	Definition Name of the updater. Range N/A
update_time	String	Definition Update time. Range N/A
edit_role	String	Definition Editing a Role Range N/A
use_role	String	Definition User role. Range N/A
approve_role	String	Definition Review role. Range N/A
enabled	Boolean	Definition Enabled or not. Range true: enabled false: disabled
workspace_id	String	Definition Workspace ID. Range N/A
version_id	String	Definition ID of the activated workflow version. Range N/A
current_approval_version_id	String	Definition ID of the version to be reviewed. Range N/A
current_rejected_version_id	String	Definition ID of the rejected version. Range N/A
aop_type	String	Definition Workflow type. NORMAL: general SURVEY: investigation HEMOSTASIS: prevention EASE: mitigation Range NORMAL SURVEY HEMOSTASIS EASE
engine_type	String	Definition Engine type. public_engine: shared version Range public_engine
dataclass_id	String	Definition Data class ID. Range N/A
dataclass_name	String	Definition Data class name. Range N/A
labels	String	Definition Workflow entity type. IP: IP address ACCOUNT: account DOMAIN: domain name Range IP ACCOUNT DOMAIN
version	String	Definition Version of the activated workflow. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
code	String	Definition Error code. Range N/A
message	String	Definition Error description. Range N/A

Example Requests

Update the workflow description to Aop workflow description Test.

{
  "name" : "Test_aop",
  "description" : "Aop workflow description Test"
}

Example Responses

Status code: 200

Response to the request for updating a workflow.

{
  "code" : "00000000",
  "data" : {
    "aop_type" : "NORMAL",
    "approve_role" : "",
    "create_time" : "2025-07-18T14:44:47.000Z+0800",
    "creator_id" : "5857617f6b8b4981baef587c08ab8b68",
    "creator_name" : "XXX",
    "current_approval_version_id" : "",
    "current_rejected_version_id" : "",
    "dataclass_id" : "e410ae50-43fa-343e-807a-a2a9edb8018e",
    "dataclass_name" : "",
    "description" : "Aop workflow description Test",
    "edit_role" : "",
    "enabled" : false,
    "engine_type" : "public_engine",
    "id" : "c19470f3-5eaf-4572-82e8-2ff094495919",
    "labels" : "IP",
    "modifier_id" : "5857617f6b8b4981baef587c08ab8b68",
    "modifier_name" : "XXX",
    "name" : "Test_aop",
    "owner_id" : "",
    "project_id" : "f69081793d9e4ea8a2f479dcef961989",
    "update_time" : "2025-07-18T14:47:16.939Z+0800",
    "use_role" : "",
    "version" : "",
    "version_id" : "",
    "workspace_id" : "f44065f5-557b-4376-ae02-8c65ef1960f4"
  },
  "message" : "",
  "request_id" : "",
  "success" : true
}