Updated on 2026-09-30 GMT+08:00

Deleting an Add-on Instance

Function

This API is used to delete an add-on instance.

Calling Method

For details, see Calling APIs.

URI

DELETE /api/v3/addons/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Definition:

Add-on pod ID

Constraints:

N/A

Range:

The value is in UUID format and contains 1 to 255 characters.

Default Value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

cluster_id

No

String

Definition:

Cluster ID. It is being deprecated. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

N/A

Range:

The value is in UUID format.

Default Value:

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition:

Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any.

Constraints:

GET requests are not validated.

Range:

N/A

Default Value:

N/A

X-Auth-Token

Yes

String

Details:

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

Constraints:

None

Options:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

-

String

Definition:

Result of deleting an add-on pod

Range:

N/A

Example Requests

None

Example Responses

Status code: 200

"success"

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.