Updated on 2025-10-29 GMT+08:00

Exporting a Workflow

Function

This API is used to export workflows.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/workflows/export

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

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

id

Yes

Array of strings

Definition

ID list of exported workflows.

Constraints

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

-

File

Exported workflow file.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

Export the workflow with ID c19470f3-5eaf-4572-82e8-2ff094495919.

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/workflows/export

{
  "id" : [ "c19470f3-5eaf-4572-82e8-2ff094495919" ]
}

Example Responses

Status code: 200

Response to the request for exporting a workflow.

"{\"Workflow file\"}"

Status Codes

Status Code

Description

200

Response to the request for exporting a workflow.

400

Abnormal response.

Error Codes

See Error Codes.