Delete a private hook

DeletePrivateHook

Deletes a private hook and all hook versions under the private hook.

The default version can be deleted only by calling this API. Other versions can be deleted by calling DeletePrivateHookVersion API.
If both hook_name and hook_id are provided, RFS checks whether they match. If they do not match, 400 is returned.

** Please use with caution. Deleting a private hook will delete the private hook and all private hook versions under this private hook. **

DELETE /v1/private-hooks/{hook_name}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
hook_name	Yes	String	Private hook name. The name is unique within its domain (domain_id) and region. It can contain Chinese characters, uppercase and lowercase letters, digits, underscores (_), and hyphens (-). The first character must be a Chinese or English character. It is case sensitive. We recommend users to use a three-part namespace for naming: {custom-hook-name}-{hook application context}-hook. Minimum: 1 Maximum: 128

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
hook_id	No	String	Unique ID of a private hook. It is an UUID generated by RFS when a private hook is created. Private hook names are unique only at one specific time, so you can create a private hook named helloWorld and another private hook with the same name after deleting the first one. For parallel development in a team, users may want to ensure that the private hook they operate is the one created by themselves, not the one with the same name created by other teammates after deleting the previous one. Therefore, they can use this ID for strong matching. RFS ensures that the ID of each private hook is different and does not change with updates. If the hook_id value is different from the current private hook ID, 400 is returned. Minimum: 36 Maximum: 36

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Client-Request-Id	Yes	String	Unique request ID. It is specified by a user and is used to locate a request. UUID is recommended. Minimum: 36 Maximum: 128

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Response code Minimum: 11 Maximum: 11
error_msg	String	Response message

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Response code Minimum: 11 Maximum: 11
error_msg	String	Response message

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Response code Minimum: 11 Maximum: 11
error_msg	String	Response message

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Response code Minimum: 11 Maximum: 11
error_msg	String	Response message

Status code: 429

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Response code Minimum: 11 Maximum: 11
error_msg	String	Response message

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Response code Minimum: 11 Maximum: 11
error_msg	String	Response message

Delete a specified private hook

DELETE https://{endpoint}/v1/private-hooks/my-hello-world-hook-name

Delete a specified private hook and check whether the provided private hook ID matches the current private hook

DELETE https://{endpoint}/v1/private-hooks/my-hello-world-hook-name?hook_id=d3e79f29-1b5c-44b2-8236-d609a59a634e

None

Status Code	Description
204	Private hook deleted. No data is returned.
400	Invalid request.
401	Authentication failed.
403	The user does not have the permission to call this API.
404	The private hook does not exist.
429	Too frequent requests.
500	Internal server error.