Help Center/ CodeArts Repo/ API Reference/ APIs/ Webhook/ Deleting a Webhook of a Specified Repository
Updated on 2025-03-28 GMT+08:00
View PDF
Share

Deleting a Webhook of a Specified Repository

Function

This API is used to delete a webhook of a specified repository.

URI

DELETE /v1/repositories/{group_name}/{repository_name}/hooks/{hook_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

group_name

Yes

String

Repository group name (the segment between the domain name and repository name in a clone address. Example: Demo00228 in git@repo.alpha.devcloud.intest.com:Demo00228/testword.git).

hook_id

Yes

Integer

ID of a hook to be deleted from a specified repository.

repository_name

Yes

String

Repository name.

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

error

Error object

Response error.

result

Object

Response result.

status

String

Response status.
Table 4 Error

Parameter

Type

Description

code

String

Error code.

message

String

Error message.

Example Requests

null

DELETE https://{endpoint}/v1/repositories/{group_name}/{repository_name}/hooks/{hook_id}

Example Responses

Status code: 200

OK

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

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Webhook