# Alibaba Cloud Security Center SOAR API

> Alibaba Cloud Security Center SOAR API on Apizie: 56 endpoints (Compares the configuration information of two published versions of a playbook, Converts the playbook flowchart configuration format from XML to X6. This operation is used for backward…, Copies a playbook, Creates an initialized playbook, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-sophonsoar`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/sophonsoar
- Page: https://zieapi.vercel.app/api/cloud/aliyun-sophonsoar
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-sophonsoar/openapi.json

Alibaba Cloud OpenAPI for Security Center SOAR (sophonsoar, version 2022-07-28). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Compares the configuration information of two published versions of a playbook
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/compare-playbooks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| OldPlaybookReleaseId | integer | yes | The UUID of the first published version used for comparison. You can call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~)… |
| NewPlaybookReleaseId | integer | yes | The UUID of the second published version used for comparison. You can call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~)… |
| Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese en: English |

### Converts the playbook flowchart configuration format from XML to X6. This operation is used for backward…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/convert-playbook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Taskflow | string | yes | The XML configuration of the playbook orchestration |
| Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English |
| RoleType | string | no | The view type. Valid values: 0: the view of the current Alibaba Cloud account. 1: the view of all accounts within the enterprise |
| RoleFor | integer | no | The user ID used when an administrator switches to the perspective of another member |

### Copies a playbook
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/copy-playbook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DisplayName | string | yes | The display name of the playbook |
| Description | string | no | The description of the playbook |
| SourcePlaybookUuid | string | yes | The UUID of the playbook to copy. You can call the https://help.aliyun.com/document_detail/3000306.html operation to obtain this parameter |
| ReleaseVersion | string | no | The release version of the playbook to copy. Default value: 0. Valid values: -1: the version currently being edited. 0: the latest… |
| Lang | string | no | The language type for the request and response messages. Valid values: zh (default): Chinese. en: English |
| RoleType | string | no | The view type. Valid values: 0 (default): the current account view. 1: the global account view |
| RoleFor | integer | no | The user ID of the member to which the administrator switches the view |

### Creates an initialized playbook
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/create-playbook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DisplayName | string | yes | The name of the playbook |
| Description | string | no | The description of the playbook |
| TaskflowType | string | no | The configuration format of the playbook. Valid values: xml: XML format. x6: JSON format |
| Lang | string | no | The language in which messages are received. Valid values: zh (default): Chinese. en: English |
| OutputParams | string | no | The output configuration of the playbook |
| InputParams | string | no | The input configuration of the playbook |

### Debugs a playbook
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/debug-playbook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| Record | string | no | The user-defined input parameters for debugging the playbook |
| Taskflow | string | yes | The XML configuration of the playbook. You can call the [DescribePlaybook](~~DescribePlaybook~~) operation to obtain this configuration |
| Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English |

### Deletes the asset information of a component configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/delete-component-asset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AssetId | integer | yes | The asset ID of the component. Call the [DescribeComponentAssets](~~DescribeComponentAssets~~) operation to obtain this parameter |
| Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English |

### Deletes a specified custom playbook
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/delete-playbook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English |

### Retrieves the asset metadata of a component, which indicates the fields that make up the asset information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-component-asset-form` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ComponentName | string | yes | The name of the component |
| Lang | string | no | The language in which messages are received. Valid values: zh (default): Chinese. en: English |

### Retrieves a list of assets for a component
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-component-assets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ComponentName | string | yes | The name of the component |
| Lang | string | no | The language of the request and response. zh: Chinese en: English |

### Retrieves the list of common components available to the user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-component-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| Lang | string | no | The language type of the request and response messages. Valid values: zh (default): Chinese. en: English |

### Retrieves the list of predefined components available to the user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-component-playbook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to retrieve this parameter |
| Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English |

### Retrieves the JavaScript file of a component. The component uses the returned JavaScript file to render pages
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-components-js` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language type for requesting and receiving messages. Valid values: zh (default): Chinese. en: English |

### Retrieves a deduplicated list of published playbook versions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-distinct-releases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query this parameter |
| TaskflowMd5 | string | no | The MD5 hash value of the XML configuration of the playbook |
| Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English |

### Retrieves the enumeration information required by the product
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-enum-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| EnumType | string | yes | The type of the enumeration value. Valid values: process: the enumeration for handling scenarios |
| Lang | string | no | The language of the request and response messages. Valid values: zh_cn: Simplified Chinese. This is the default value. en_us: English (US) |

### Queries a list of executable playbooks that are used to configure automated response plans
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-execute-playbooks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InputMode | string | no | The entity type of the input parameter for the playbook. To query multiple entity types, separate them with commas. ip: IP entity. file:… |
| PlaybookName | string | no | The name of the playbook. Fuzzy search is supported |
| Uuid | string | no | The UUID of the playbook. Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese en: English |
| ParamType | string | no | The type of the input parameter for the playbook. template-ip: IP request template. template-file: file request template.… |

### Retrieves the global and general configuration information for the product
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| QueryKey | string | yes | The key of the global configuration. Valid values: soar_filed_tags: Retrieves the input template of the playbook |
| Lang | string | no | The language of the request and response messages. Valid values: zh (default): Chinese. en: English |

### Retrieves the group list of Alibaba Cloud products
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-group-productions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language type of the received message. Valid values: zh (default): Chinese. en: English |
| RoleType | string | no | The view type. Valid values: 0 (default): the view of the current Alibaba Cloud account. 1: the view of all accounts within the enterprise |
| RoleFor | integer | no | The user ID used when an administrator switches to the perspective of another member |

### Dynamically generates the output schema information for each node of a playbook based on the latest…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-latest-record-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| Lang | string | no | Specifies the language for the request and response. Default value: zh. Valid values: zh: Chinese en: English |

### Returns the reference paths for component inputs in a playbook orchestration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-node-param-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| NodeName | string | yes | The name of the component node |
| Lang | string | no | The language of the request and response. zh: Chinese en: English |

### Queries the list of notification message templates
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-notify-template-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language type for the request and response messages. Valid values: zh (default): Chinese. en: English |
| RoleType | string | no | The view type. Default value: 0. Valid values: 0: the view of the current Alibaba Cloud account. 1: the view of all accounts within the… |
| RoleFor | integer | no | The user ID used when an administrator switches to the perspective of another member |

### Retrieves the details of a product API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-open-api-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PopCode | string | yes | The POP code of the Alibaba Cloud product API |
| ApiVersion | string | yes | The version number of the API. Call the [DescribeGroupProductions](~~DescribeGroupProductions~~) operation to obtain this parameter |
| ApiName | string | yes | The name of the API |
| Lang | string | no | The language type of the received messages. Valid values: zh (default): Chinese. en: English |
| RoleType | string | no | The view type. Valid values: 0 (default): the view of the current Alibaba Cloud account. 1: the view of all accounts within the enterprise |
| RoleFor | integer | no | The user ID used when an administrator switches to the perspective of another member |

### Retrieves the list of API operations for a product
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-open-api-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PopCode | string | yes | The POP code of the Alibaba Cloud product API |
| ApiVersion | string | yes | The version number of the API. Call the [DescribeGroupProductions](~~DescribeGroupProductions~~) operation to obtain this parameter |
| ApiName | string | no | The name of the API |
| Lang | string | no | The language type for requests and responses. Default value: zh. Valid values: zh: Chinese en: English |
| RoleType | string | no | The view type. Default value: 0. Valid values: 0: the view of the current Alibaba Cloud account. 1: the view of all accounts within the… |
| RoleFor | integer | no | The user ID used when an administrator switches to the perspective of another member |

### Retrieves the XML configuration of a playbook
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-playbook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| Lang | string | no | The language of the request and response. The default value is zh. Valid values: zh: Chinese en: English |
| TaskflowMd5 | string | no | The MD5 value of the playbook configuration |
| DebugFlag | integer | no | A flag that indicates whether the version is a published version or a debug version. Valid values: 1: retrieves the debug version. 0:… |

### Retrieves the configuration information of the input and output parameters for a playbook
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-playbook-input-output` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| Lang | string | no | Specifies the language of the request and response. Default value: zh. Valid values: zh: Chinese en: English |

### Queries playbook metadata, including its name, description, number of runs, and failure rate
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-playbook-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| Lang | string | no | The language of the request and response. The default value is zh. Valid values: zh: Chinese en: English |

### Retrieves the historical output data of a component
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-playbook-nodes-output` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| NodeName | string | yes | The name of the component node |
| Lang | string | no | The language of the request and response. The default value is zh. Valid values: zh: Chinese en: English |

### Retrieves metrics for the response orchestration product, including the total number of playbooks and the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-playbook-number-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the request and response. zh (default): Chinese en: English |

### Queries a list of published versions of a playbook
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-playbook-releases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook |
| Lang | string | no | The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English |
| PageSize | integer | no | The number of entries per page. Default value: 20. If you do not specify this parameter, 10 entries are returned. Specify a value for this… |
| PageNumber | integer | no | The page number of the page to return. Default value: 1 |

### Retrieves a list of playbooks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-playbooks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Active | integer | no | The status of the playbook. Valid values: 1: Enabled. 0: Disabled |
| OwnType | string | no | The type of the playbook. Valid values: preset: predefined playbook. user: custom playbook |
| StartMillis | integer | no | The start time of the query. Format: 13-digit timestamp |
| EndMillis | integer | no | The end time of the query. Format: 13-digit timestamp |
| PlaybookUuid | string | no | The UUID of the playbook. You can call the [CreatePlaybook](~~CreatePlaybook~~) operation to obtain this parameter |
| Name | string | no | The name of the playbook |
| Lang | string | no | The language type of the request and response. Default value: zh. Valid values: zh: Chinese. en: English |
| PageSize | integer | no | The maximum number of entries per page in a paginated query. The default number of entries per page is 20. If the PageSize parameter is… |
| PageNumber | integer | no | The page number from which to start displaying query results. Default value: 1, which indicates that results are displayed starting from… |
| Sort | integer | no | The sorting basis. Default value: 1. Valid values: 1: last modified time. 2: last execution time |
| Order | string | no | The sort order. Default value: desc. Valid values: desc: descending order. asc: ascending order |
| ParamTypes | string | no | The playbook trigger type. Default value: query all. Valid values: template-incident: security incident. template-ip: IP entity.… |
| PlaybookUuids | string | no | The collection of playbook UUIDs. A maximum of 100 UUIDs are supported. Separate multiple UUIDs with commas (,) |

### Retrieves the details of an OpenAPI
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-pop-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PopCode | string | yes | The POP code of the Alibaba Cloud product API |
| ApiVersion | string | yes | The version number of the API |
| ApiName | string | yes | The name of the Alibaba Cloud product API |

### Retrieves statistics information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-process-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the response message. Valid values: zh (default): Chinese. en: English |
| RoleType | string | no | The view type. Valid values: 0 (default): the view of the current Alibaba Cloud account. 1: the view of all accounts within the enterprise |
| RoleFor | string | no | The user ID used when an administrator switches to the perspective of another member |
| ProcessActionStart | integer | no | The start time for querying disposal tasks. Format: a 13-digit timestamp |
| ProcessActionEnd | integer | no | The end time for querying disposal tasks. Format: a 13-digit timestamp |

### Queries the count of response tasks associated with an entity UUID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-process-task-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| EntityUuidList | string | yes | The UUIDs of the entities (JSON-encoded) |
| Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English |
| RoleType | string | no | The view type. 0: The view of the current Alibaba Cloud account. 1: The view of all accounts that belong to the enterprise |
| RoleFor | integer | no | The UID of the member whose permissions you want to use to call the operation |

### Retrieves the list of disposal tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-process-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ProcessStrategyUuid | string | no | The UUID of the disposal strategy. Call the https://help.aliyun.com/document_detail/2584440.html operation to obtain this parameter |
| EntityName | string | no | The name of the entity to be disposed |
| EntityType | string | no | The type of the entity to be disposed. Valid values: ip: IP entity. file: File entity. process: Process entity |
| SceneCode | string | no | The scene code of the disposal task. Call the [DescribeEnumItems](~~DescribeEnumItems~~) operation to obtain this parameter |
| TaskStatus | string | no | The status list of the disposal task, in array string format. Valid values: 11: Disposing. 21: Blocking. 22: Isolating. 23: Ended. 24:… |
| Scope | string | no | The Alibaba Cloud account ID for the disposal |
| Source | string | no | The trigger source of the disposal task, in array string format. Valid values: system: Triggered by manual event disposal. custom:… |
| ProcessActionStart | integer | no | The start time for querying disposal time. Format: 13-digit timestamp |
| ProcessActionEnd | integer | no | The end time for querying disposal time. Format: 13-digit timestamp |
| ProcessRemoveStart | integer | no | The start time for querying unblocking time. Format: 13-digit timestamp |
| ProcessRemoveEnd | integer | no | The end time for querying unblocking time. Format: 13-digit timestamp |
| ParamContent | string | no | The fuzzy match keyword. This parameter matches the entity, disposal scene, and disposal parameter fields |
| PageSize | integer | no | The maximum number of entries per page in a paginated query. The default number of entries per page is 20. If the PageSize parameter is… |
| PageNumber | integer | no | The page number from which to start displaying query results. Default value: 1, which indicates that results are displayed starting from… |
| YunCode | string | no | The cloud product associated with the disposal task, in array string format. Valid values: WAF: Web Application Firewall. CFW: Cloud… |
| TaskId | string | no | The unique identifier of the disposal task. This parameter is used to query a specific task. You can obtain the value from the response of… |
| OrderField | string | no | The field used to sort the results. The sort field can be obtained from the response of this operation |
| Direction | string | no | The sort direction. Valid values: desc: Descending (default). asc: Ascending |
| EntityUuid | string | no | The entity UUID |
| EventUuid | string | no | The event UUID |
| TriggerSource | string | no | The trigger source of the disposal task. Valid values: system: Triggered by manual event disposal. custom: Triggered by an automated… |
| ReqUuid | string | no | The playbook trigger ID |
| AlertId | string | no | The AlertId |
| ExecuteUuid | string | no | The ExecuteUuid |
| ResponseRuleId | string | no | The ResponseRuleId |

### Retrieves the output data generated by a component for an action in a playbook task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-soar-record-action-output-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ActionUuid | string | yes | The UUID of the component action. Call the [DescribeSoarTaskAndActions](~~DescribeSoarTaskAndActions~~) operation to get this parameter |
| Lang | string | no | The language of the request and response. Default value: zh. Valid values: zh: Chinese en: English |
| PageSize | integer | yes | The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 10 entries are returned. We recommend… |
| PageNumber | integer | yes | The page number of the results to return. Default value: 1 |

### Retrieves the input and output data of a component action after a playbook task is executed
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-soar-record-in-output` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ActionUuid | string | yes | The UUID of the component action. Call the [DescribeSoarTaskAndActions](~~DescribeSoarTaskAndActions~~) API to get this parameter |
| Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English |

### Queries the execution records for a playbook
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-soar-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | no | The UUID of the playbook. For more information, see [DescribePlaybooks](~~DescribePlaybooks~~) |
| TaskflowMd5 | string | no | The MD5 value of the playbook configuration |
| StartMillis | integer | no | The start time of the task run. The value is a 13-digit UNIX timestamp |
| EndMillis | integer | no | The end time of the task run. The value is a 13-digit UNIX timestamp |
| Lang | string | no | The language of the request and response. Default value: zh. Valid values: zh: Chinese en: English |
| TriggerUser | string | no | The ID of the Alibaba Cloud account that runs the playbook task |
| TaskStatus | string | no | The status of the task run. Valid values: success: The task is successful. failed: The task failed. inprogress: The task is in progress |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 10 entries are returned on each page.… |
| RequestUuid | string | no | The UUID of the playbook task execution. For more information, see https://help.aliyun.com/document_detail/2627455.html |
| TriggerType | string | no | The trigger type of the task. Valid values: stream: stream debug: test manual: manual timer: scheduled SubInvoke: child flow siem:… |
| QueryValue | string | no | The input parameter of the playbook |
| CompletedBeginTime | integer | no | The start time when the task was completed. The value is a 13-digit UNIX timestamp |
| CompletedEndTime | integer | no | The end time when the task was completed. The value is a 13-digit UNIX timestamp |

### Retrieves the component execution records for a single playbook run
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-soar-task-and-actions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RequestUuid | string | no | The UUID of the playbook task |
| Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese en: English |
| PageNumber | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. The maximum value is 20. If you do not specify this parameter, 10 entries are returned.… |
| QueryValue | string | no | The input parameter of the playbook |
| QueryType | string | no | The trigger type of the task. Valid values: stream: The task is triggered by a data stream. debug: The task is triggered by a debugging… |

### Queries the commands that are used to manage entities
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-sophon-commands` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | no | The name of the command. Fuzzy search is supported |

### Queries the list of OpenAPIs from cloud vendors
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describe-vendor-api-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PageNumber | integer | no | The page number of the current page. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| KeyWord | string | no | The keyword |
| ProductCode | string | no | The product code of the vendor. Valid values: waf: Web Application Firewall (WAF). cfw: Cloud Firewall |
| ApiName | string | no | The name of the Alibaba Cloud product API. Fuzzy search is supported |
| VendorCode | string | no | The vendor code. Valid values: Tencent: Tencent. HUAWEICLOUD: Huawei. Azure: Microsoft Azure. AWS: Amazon Web Services. Chaitin: Chaitin |

### After you submit a task for a Python 3 script, use the returned requestUuid to retrieve the operational logs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/describer-python3-script-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RequestUuid | string | yes | The UUID that is returned when you run a Python 3 script. Call the [RunPython3Script](~~RunPython3Script~~) operation to obtain this… |
| Lang | string | no | The language of the request and response. zh (default): Chinese en: English |

### You can call this operation to modify the asset information for a component
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/modify-component-asset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AssetConfig | string | yes | The configuration of the component asset. This parameter is a JSON object |
| Lang | string | no | The language of the request and response. zh (default): Chinese en: English |

### Modifies the configuration of a playbook
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/modify-playbook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| DisplayName | string | yes | The display name of the playbook |
| Taskflow | string | no | The XML configuration of the playbook |
| Description | string | no | The description of the playbook |
| Lang | string | no | The language of the request and response. zh (default): Chinese en: English |

### Modifies the input and output parameters of a playbook
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/modify-playbook-input-output` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| InputParams | string | yes | The input parameter configuration for the playbook. This parameter is in the JSONArray format |
| OutputParams | string | yes | Playbooks do not support output parameter configurations. This parameter is fixed to an empty value |
| ParamType | string | no | The type of the input parameter for the playbook. template-ip: IP request template. template-file: file request template.… |
| ExeConfig | string | no | The execution method for the playbook. This parameter is in the JSONObject format |
| Lang | string | no | The language of the request and response messages. zh (default): Chinese en: English |

### Publishes a playbook. Once published, the playbook runs with the new logic
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/publish-playbook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| Description | string | no | The description of the published version |

### Retrieves a list of all playbooks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/query-tree-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Lang | string | no | The language of the response. Valid values: zh (default): Chinese en: English |

### Rolls back a playbook to a specified version. You can also specify whether to publish the version during the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/revert-playbook-release` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| PlayReleaseId | integer | yes | The ID of the playbook release version. You can call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~) operation to obtain this… |
| IsPublish | string | no | Specifies whether to publish the version directly after the rollback. true (default): Publish and roll back. false: Only roll back without… |

### Sends a message by using the email notification component
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/run-notify-component-with-email` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Receivers | string | yes | The list of email addresses (JSON-encoded) |
| Subject | string | yes | The email subject |
| Content | string | yes | The email body |
| PlaybookUuid | string | yes | The playbook UUID. You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| NodeName | string | yes | The node name of the playbook |
| ComponentName | string | yes | The component name of the playbook |
| ActionName | string | yes | The action name of the component |
| AssetId | string | no | The resource instance ID of the email sender. You can call the [DescribeComponentAssets](~~DescribeComponentAssets~~) operation to obtain… |
| Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese en: English |
| RoleType | string | no | The view type. Valid values: 0: the view of the current Alibaba Cloud account. 1: the view of all accounts within the enterprise |
| RoleFor | integer | no | The user ID of the member to which the administrator switches the view |

### Executes the notification component to send a message through Message Center
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/run-notify-component-with-message-center` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Aliuid | string | yes | The user ID of the message recipient |
| EventId | string | yes | The message event ID. Valid values: yundun_soar_incident_generate: incident generation yundun_soar_alert_generate: alert generation… |
| Params | string | no | The template parameters of the message event. Incident generation: aliyunUID, incidentName, incidentID, startTime Alert generation:… |
| ChannelTypeList | string | no | The list of channel types. If this parameter is not specified, messages are sent through all channels configured for the message event. By… |
| PlaybookUuid | string | yes | The UUID of the playbook. You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| NodeName | string | yes | The node name of the playbook |
| ComponentName | string | yes | The component name of the playbook |
| ActionName | string | yes | The action name of the playbook |
| AssetId | string | no | [Deprecated] The resource instance ID. This parameter is deprecated and no longer used |
| Lang | string | no | The language type for the request and response messages. Valid values: zh (default): Chinese en: English |
| RoleType | string | no | The view type. Valid values: 0 (default): the view of the current Alibaba Cloud account. 1: the view of all accounts within the enterprise |
| RoleFor | integer | no | The user ID of the member to which the administrator switches the view |

### Sends a message by using the notification component webhook
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/run-notify-component-with-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Webhook | string | yes | The collection of robot IDs configured on the Message Center - Robot Receiving Management page. Currently, only DingTalk robot type is… |
| Secret | string | no | The DingTalk group robot webhook message secret. This parameter is deprecated and no longer used |
| MsgType | string | yes | The webhook message type. Valid values: text markdown actionCard |
| Content | string | yes | The message body sent by the DingTalk group robot webhook |
| PlaybookUuid | string | yes | The UUID of the playbook. You can call the https://help.aliyun.com/document_detail/3000306.html operation to obtain this parameter |
| NodeName | string | yes | The node name of the playbook |
| ComponentName | string | yes | The component name of the playbook |
| ActionName | string | yes | The action name of the playbook |
| AssetId | string | no | The resource instance ID. This parameter is deprecated and no longer used |
| Lang | string | no | The language type for the request and response messages. Valid values: zh (default): Chinese. en: English |
| RoleType | string | no | The view type. Valid values: 0 (default): the view of the current Alibaba Cloud account. 1: the view of all accounts within the enterprise |
| RoleFor | integer | no | The user ID of the member whose perspective the administrator switches to |

### Submits and executes a Python 3 code snippet. This operation can only be used for data processing
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/run-python3-script` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PythonScript | string | no | The Python 3 script |
| Params | string | no | The input parameters of the Python 3 script |
| PlaybookUuid | string | no | The UUID of the playbook. You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| NodeName | string | no | The node name of the playbook |
| PythonVersion | string | no | The Python version |

### Triggers an enabled custom playbook or predefined playbook
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/trigger-playbook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | yes | The UUID of the playbook. You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| InputParam | string | yes | The input parameters of the playbook |

### When an event is handled using response orchestration, the response center creates a task. Perform follow-up…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/trigger-process-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TaskId | string | yes | The unique ID of the handling task. Call the [DescribeProcessTasks](~~DescribeProcessTasks~~) operation to obtain this parameter |
| ActionType | string | yes | The type of the handling action. Valid values: remove: Removes a block or an asset from isolation. retry: Resubmits the task |

### Triggers a playbook or response command
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/trigger-sophon-playbook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClientToken | string | no | The idempotency token |
| CommandName | string | no | The name of the command that you want to trigger. You can call the [DescribeSophonCommands](~~DescribeSophonCommands~~) operation to… |
| InputParams | string | yes | The input parameters for triggering the command or playbook |
| SophonTaskId | string | no | The custom business ID. If you do not specify this parameter when triggering a playbook, a random ID is generated. This ID is used for… |
| Uuid | string | no | The UUID of the playbook. You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter |
| TriggerType | string | no | The trigger type. Valid values: command: triggers a command task. playbook: triggers a playbook task |

### Validates whether the playbook configuration is correct and whether the orchestration logic is reasonable
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/verify-playbook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlaybookUuid | string | no | The UUID of the playbook. Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter. Note: You must specify… |
| TaskFlow | string | no | The XML configuration of the playbook |

### Verifies the syntax of a Python code snippet
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/verify-python-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Content | string | yes | The Python code snippet to verify |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/version` (byok)

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/compare-playbooks" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Security Center SOAR API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-sophonsoar/compare-playbooks with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Security Center SOAR API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Security Center SOAR itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Security Center SOAR API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-sophonsoar.

### What is the status of the Alibaba Cloud Security Center SOAR API?
Needs your own provider key (bring your own key)