Deleting Pipelines in Batches

Function

This API is used to delete pipelines in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipelines/batch-delete

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
pipeline_ids	Yes	Array of strings	Definition: Pipeline ID list. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	Array of result objects	Definition Response body for batch operations on pipelines. Range N/A

**Table 4** result
Parameter	Type	Description
pipeline_id	String	Definition Pipeline ID. Range The value consists of 32 characters, including only digits and letters.
pipeline_name	String	Definition Pipeline name. Range Enter 1 to 128 characters, including only letters, digits, hyphens (-), and underscores (_).
status	String	Definition Operation status. DELETE_FAILED: The deletion is successful. DELETE_SUCCESS: The deletion fails. SUCCESS: The operation is successful. FAILED: The operation fails. Range DELETE_FAILED, DELETE_SUCCESS, SUCCESS, and FAILED.
reason	String	Definition Operation failure cause. Range N/A

Example Requests

POST https://{endpoint}}/v5/db8d07265e24426598b3eb03a7818972/api/pipelines/batch-delete

{
  "pipeline_ids" : [ "d02cd56c8bfa406d96286454c87bd85a", "32d334890ff74d16b3f51df386f16407" ]
}

Example Responses

Status code: 200

{
  "result" : [ {
    "pipeline_id" : "d02cd56c8bfa406d96286454c87bd85a",
    "pipeline_name" : "Delete 2",
    "status" : "DELETE_SUCCESS",
    "reason" : null
  }, {
    "pipeline_id" : "32d334890ff74d16b3f51df386f16407",
    "pipeline_name" : "Delete 111",
    "status" : "DELETE_SUCCESS",
    "reason" : null
  } ]
}