Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Deleting a Task
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting a Task

Function

This API is used to delete a code check task by task ID. After the deletion, the task configurations, issues, and execution records cannot be restored.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartscheck:task:delete

Write

task *

-

-

-

-

codeartscheck:ProjectId

URI

DELETE /v3/task/{task_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition :

Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID.

Constraints:

N/A

Value range:

1 to 128 characters.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

operator

No

String

Definition:

Operator.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

httpStatus

String

Definition:

HTTP response status.

Value range:

  • OK: The request has been successfully processed, and the server returns the requested resource or operation result.

  • ACCEPTED: The request has been accepted by the server, but the processing is not complete (usually used for asynchronous operations).

  • INTERNAL_SERVER_ERROR: internal API exception.

  • BAD_REQUEST: abnormal parameter verification.

result

String

Definition:

If the deletion is successful, the result field's value is true.

Value range:

N/A

status

String

Definition:

API response status.

Value range:

  • success: successful response.

  • error: response failed.

Example Requests

Delete the code check task whose ID is 897acf5exxx48a5013cd.

DELETE https://{endpoint}/v3/task/897acf5exxx48a5013cd

Example Responses

Status code: 200

Task deleted.

{
  "httpStatus" : "OK",
  "result" : true,
  "status" : "success"
}

Status Codes

Status Code

Description

200

Task deleted.

Error Codes

See Error Codes.

Parent Topic: Task Management