Help Center> CodeArts Deploy> API Reference> APIs> Managing Applications> Deleting Applications from a Project in Batches

Updated on 2024-07-05 GMT+08:00

Online Debugging

CLI Examples

View PDF

Deleting Applications from a Project in Batches

Function

This API is used to delete applications from a project in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v2/applications/batch-delete

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 0 Maximum: 20000

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
application_ids	Yes	Array of strings	Application ID list Array Length: 1 - 50

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	Array of AppDeleteResult objects	Result of deleting applications in batches Array Length: 1 - 50
total_num	Integer	Total number of applications deleted in batches Minimum: 1 Maximum: 50

**Table 4** AppDeleteResult
Parameter	Type	Description
application_id	String	Application ID
application_name	String	Application name Minimum: 3 Maximum: 128
status	String	Deletion result: success or error Enumeration values: success error
error_reason	String	Causes of deletion failures Minimum: 0 Maximum: 100

Example Requests

https://{endpoint}/v2/applications/batch-delete

{
  "application_ids" : [ "eac65c10c5c34df1824af96ec93a9eea", "3ba2ad194ff141e39b1d3d0749242858" ],
  "project_id" : "0a38ce9ba3c740c199a0f872b6163661"
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "result" : [ {
    "application_id" : "eac65c10c5c34df1824af96ec93a9eea",
    "application_name" : "Application name 1",
    "error_reason" : "",
    "status" : "success"
  }, {
    "application_id" : "eac65c10c5c34df1824af96ec93a9eeb",
    "application_name" : "Application name 2",
    "error_reason" : "No permissions.",
    "status" : "error"
  } ],
  "total_num" : 2
}