Help Center> CodeArts Pipeline> API Reference> API> Rule Management> Deleting a Rule
Updated on 2024-07-04 GMT+08:00
Online Debugging
CLI Examples
View PDF

Deleting a Rule

Function

This API is used to delete a rule.

Calling Method

For details, see Calling APIs.

URI

DELETE /v2/{domain_id}/rules/{rule_id}/delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Tenant ID.

rule_id

Yes

String

Rule ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

Boolean

Status.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

DELETE https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/rules/2965ed53fe804115816b781ab20fef3c/delete

Example Responses

Status code: 200

Request succeeded.

{
  "status" : true
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

Authentication failed.

403

No permission.

404

Resource not found.

Error Codes

See Error Codes.

Parent Topic: Rule Management