Help Center> CodeArts Deploy> API Reference> APIs> Application Management> Deleting an Application (Recommended)
Updated on 2023-11-28 GMT+08:00

Deleting an Application (Recommended)

Function

This API is used to delete an application of a specified ID.

URI

DELETE /v1/applications/{app_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

app_id

Yes

String

Application ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). Possible values: application/json;charset=utf-8 application/json

Default: application/json;charset=utf-8

Enumeration values:

  • application/json;charset=utf-8

  • application/json

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Request success or failure status.

result

AppBaseResponse object

Response body for creating or deleting an application

Table 4 AppBaseResponse

Parameter

Type

Description

id

String

Created application ID.

name

String

This API is used to create an application name.

region

String

Region to which the application belongs.

arrange_infos

Array of TaskBaseBody objects

Deployment task list.

Table 5 TaskBaseBody

Parameter

Type

Description

id

String

Created deployment task ID.

Example Requests

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

Example Responses

Status code: 200

OK: The request is successful.

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

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.