Help Center/ Cloud Search Service_KooSearch/ API Reference/ API/ Outdated APIs/ Definition of user document parsing rules/ Deleting a User-Defined Parsing Rule
Updated on 2025-08-13 GMT+08:00
View PDF
Share

Deleting a User-Defined Parsing Rule

Function

This API is used to delete a user-defined parsing rule.

URI

DELETE /v1/koosearch/rule-regex/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

id

Yes

String

User-defined rule ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Parameter description:

Token used for API authentication. For how to obtain the token, see section 3.2 "Authentication."

Constraints:

N/A.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

ID of the rule to be deleted.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

None

Example Responses

Status code: 200

Deleted.

{
  "id" : "1777619994213965826"
}

Status Codes

Status Code

Description

200

Deleted.

400

Incorrect request body parameter

500

Internal error

Error Codes

See Error Codes.