Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kazuhiko Shiozaki
gitlab-ce
Commits
c5b429f0
Commit
c5b429f0
authored
Jan 14, 2016
by
Tomasz Maczukin
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add mofications to triggers API documentation [ci skip]
parent
d8359a4f
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
12 additions
and
32 deletions
+12
-32
doc/api/build_triggers.md
doc/api/build_triggers.md
+12
-32
No files found.
doc/api/build_triggers.md
View file @
c5b429f0
# Build triggers
You can read more about
[
triggering builds through the API
](
../ci/triggers/README.md
)
.
## List project triggers
Get a list of project
triggers
Get a list of project
's build triggers.
```
GET /projects/:id/triggers
```
### Parameters
| Attribute | Type | required | Description |
|-----------|---------|----------|---------------------|
| id | integer | yes | The ID of a project |
### Example of request
|
`id`
| integer | yes | The ID of a project |
```
curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers"
```
### Example of response
```
json
[
{
...
...
@@ -43,27 +39,21 @@ curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3
## Get trigger details
Get details of
trigger of a project
Get details of
project's build trigger.
```
GET /projects/:id/triggers/:token
```
### Parameters
| Attribute | Type | required | Description |
|-----------|---------|----------|--------------------------|
| id | integer | yes | The ID of a project |
| token | string | yes | The
`token`
of a project |
### Example of request
|
`id`
| integer | yes | The ID of a project |
|
`token`
| string | yes | The
`token`
of a trigger |
```
curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers/7b9148c158980bbd9bcea92c17522d"
```
### Example of response
```
json
{
"created_at"
:
"2015-12-23T16:25:56.760Z"
,
...
...
@@ -76,26 +66,20 @@ curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3
## Create a project trigger
Create a
trigger for a project
Create a
build trigger for a project.
```
POST /projects/:id/triggers
```
### Parameters
| Attribute | Type | required | Description |
|-----------|---------|----------|--------------------------|
| id | integer | yes | The ID of a project |
### Example of request
|
`id`
| integer | yes | The ID of a project |
```
curl -X POST -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers"
```
### Example of response
```
json
{
"created_at"
:
"2016-01-07T09:53:58.235Z"
,
...
...
@@ -108,20 +92,16 @@ curl -X POST -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.co
## Remove a project trigger
Remove a
trigger of a project
Remove a
project's build trigger.
```
DELETE /projects/:id/triggers/:token
```
### Parameters
| Attribute | Type | required | Description |
|-----------|---------|----------|--------------------------|
| id | integer | yes | The ID of a project |
| token | string | yes | The
`token`
of a project |
### Example of request
|
`id`
| integer | yes | The ID of a project |
|
`token`
| string | yes | The
`token`
of a project |
```
curl -X DELETE -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/triggers/7b9148c158980bbd9bcea92c17522d"
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment