debian-mirror-gitlab/doc/api/system_hooks.md

141 lines
2.6 KiB
Markdown
Raw Normal View History

2014-09-02 18:07:02 +05:30
# System hooks
2016-04-02 18:10:28 +05:30
All methods require administrator authorization.
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
The URL endpoint of the system hooks can also be configured using the UI in
the admin area under **Hooks** (`/admin/hooks`).
Read more about [system hooks](../system_hooks/system_hooks.md).
2014-09-02 18:07:02 +05:30
## List system hooks
2016-04-02 18:10:28 +05:30
Get a list of all system hooks.
---
2014-09-02 18:07:02 +05:30
```
GET /hooks
```
2016-04-02 18:10:28 +05:30
Example request:
```bash
2016-09-13 17:45:13 +05:30
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/hooks
2016-04-02 18:10:28 +05:30
```
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
Example response:
2014-09-02 18:07:02 +05:30
```json
[
2016-04-02 18:10:28 +05:30
{
"id" : 1,
"url" : "https://gitlab.example.com/hook",
"created_at" : "2015-11-04T20:07:35.874Z"
}
2014-09-02 18:07:02 +05:30
]
```
2016-04-02 18:10:28 +05:30
## Add new system hook
Add a new system hook.
---
2014-09-02 18:07:02 +05:30
```
POST /hooks
```
2016-04-02 18:10:28 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `url` | string | yes | The hook URL |
Example request:
```bash
2016-09-13 17:45:13 +05:30
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/hooks?url=https://gitlab.example.com/hook"
2016-04-02 18:10:28 +05:30
```
Example response:
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
```json
[
{
"id" : 2,
"url" : "https://gitlab.example.com/hook",
"created_at" : "2015-11-04T20:07:35.874Z"
}
]
```
2014-09-02 18:07:02 +05:30
## Test system hook
```
GET /hooks/:id
```
2016-04-02 18:10:28 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of the hook |
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
Example request:
```bash
2016-09-13 17:45:13 +05:30
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/hooks/2
2016-04-02 18:10:28 +05:30
```
Example response:
2014-09-02 18:07:02 +05:30
```json
{
2016-04-02 18:10:28 +05:30
"project_id" : 1,
"owner_email" : "example@gitlabhq.com",
"owner_name" : "Someone",
"name" : "Ruby",
"path" : "ruby",
"event_name" : "project_create"
2014-09-02 18:07:02 +05:30
}
```
## Delete system hook
2016-04-02 18:10:28 +05:30
Deletes a system hook. This is an idempotent API function and returns `200 OK`
even if the hook is not available.
If the hook is deleted, a JSON object is returned. An error is raised if the
hook is not found.
---
2014-09-02 18:07:02 +05:30
```
DELETE /hooks/:id
```
2016-04-02 18:10:28 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of the hook |
Example request:
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
```bash
2016-09-13 17:45:13 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/hooks/2
2016-04-02 18:10:28 +05:30
```
Example response:
```json
{
"note_events" : false,
"project_id" : null,
"enable_ssl_verification" : true,
"url" : "https://gitlab.example.com/hook",
"updated_at" : "2015-11-04T20:12:15.931Z",
"issues_events" : false,
"merge_requests_events" : false,
"created_at" : "2015-11-04T20:12:15.931Z",
"service_id" : null,
"id" : 2,
"push_events" : true,
"tag_push_events" : false
}
```