Obtaining a Project Hook

Function

This API is used to obtain a project hook.

Debugging

You can debug this API in API Explorer which supports automatic authentication. API Explorer automatically generates sample SDK code and provides the debug function.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v1/{project_id}/git/repos/{namespace}/{project}/hooks

Table 1 describes the parameters.

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant's project ID. See Obtaining a Project ID.
namespace	Yes	String	Namespace ID or URL code name. See Obtaining a Repository Namespace.
project	Yes	String	Repository project ID or URL code name. If the value contains a slash (/), replace it with a colon (:). See Obtaining All Projects in a Namespace.

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Default value: application/json;charset=utf8.
X-Auth-Token	Yes	String	API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain a token, see Obtaining a User Token Through Password Authentication.
X-Repo-Auth	Yes	String	Authorization name. See Obtaining a Git Repository Authorization List.

Response

**Table 3** Response parameter
Parameter	Type	Description
hooks	Array of objects	Project hooks. See Table 4.

**Table 4** hooks
Parameter	Type	Description
id	String	Hook ID.
type	String	Hook type.
callback_url	String	Callback URL.

Example Request

None

Example Response

{
  "hooks": [
    {
      "id": "1753",
      "type": "github",
      "callback_url": "https://example.com/webhook"
    }
  ]
}

Status Code

Status Code	Description
200	OK
400	Bad Request

Error Code

See ServiceStage Error Codes.

Parent topic: Git Repository Access APIs

Previous topic: Obtaining Project Commits

Next topic: Creating a Project Hook

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot