Help Center/ CodeArts Deploy/ API Reference (Ally Region)/ APIs/ Managing Applications/ Deleting an Application (Recommended)
Updated on 2026-01-08 GMT+08:00
Online Debugging
CLI Examples
Share

Deleting an Application (Recommended)

Function

This API is used to delete an application by ID.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/applications/{app_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

app_id

Yes

String

Parameter description:

Application ID.

Constraints:

N/A

Value range:

The value consists of 32 characters. Only letters and digits are allowed.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition:

Type (or format) of the message body.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used for.

Constraints:

N/A.

Value range:

String. Max. 20,000 characters.

Default value:

N/A.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Parameter description:

Request success or failure status.

Value range:

  • success: Request succeeded

  • error: Request failed

result

AppBaseResponse object

Definition:

Response body for application basic information.
Table 4 AppBaseResponse

Parameter

Type

Description

id

String

Parameter description:

Application ID.

Value range:

The value consists of 32 characters. Letters and digits are allowed.

name

String

Parameter description:

Application name.

Value range:

The value consists of 3-128 characters. Only letters, digits, hyphens (-) and underscores (_) are allowed.

region

String

Parameter description:

Region to which the application belongs.

Value range:

N/A

arrange_infos

Array of TaskBaseBody objects

Parameter description:

Deployment task list.
Table 5 TaskBaseBody

Parameter

Type

Description

id

String

Parameter description:

Deployment application ID.

Value range:

The value consists of 32 characters. Letters and digits are allowed.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

https://{endpoint}/v1/applications/b024060ac00749178e72713ae82b0da2

Example Responses

Status code: 200

OK: The request is successful.

{
  "result" : {
    "id" : "20168cbc8504479d84f118ae72f87763",
    "name" : "test_app",
    "region" : "region-a",
    "arrange_infos" : [ {
      "id" : "5d55203938db46939cd41a66ef2c4a52"
    } ]
  },
  "status" : "success"
}

Status code: 400

Bad Request

{
  "error_code" : "Deploy.00015002",
  "error_msg" : "Invalid request parameter."
}

Status code: 403

Forbidden

{
  "error_code" : "Deploy.00011154",
  "error_msg" : "You do not have permissions to perform this operation."
}

Status Codes

Status Code

Description

200

OK: The request is successful.

400

Bad Request

403

Forbidden

Error Codes

See Error Codes.

Parent topic: Managing Applications