Updated on 2026-10-27 GMT+08:00

Deleting a Sprint (V2)

Function

This API is used to delete a sprint.

Calling Method

For details, see Calling APIs.

Authorization Information

No identity policy-based permission required for calling this API.

URI

POST /v2/version/delete

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

The value contains 10 to 32,768 characters.

Default Value

N/A

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

project_id

No

String

Definition:

32-character ID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the API for querying the project list.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

version_id

No

String

Definition

Unique ID of the deleted sprint. The value is obtained by calling the Querying the Sprint API. The ID in the version field in the response body is the ID of the current sprint.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

String

Definition:

Result of the request for deleting a sprint.

Value range:

N/A

status

String

Definition:

Status of the request for deleting a sprint.

Value range:

success: The sprint is successfully deleted.

error: The sprint deletion failed.

Example Requests

POST https://{endpoint}/v2/version/delete

{
  "project_id" : "ac73924a87d0455ca9b16b0ed15fe367",
  "version_id" : "26658661"
}

Example Responses

Status code: 200

{
  "result" : "",
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK (The request has succeeded).

Error Codes

See Error Codes.