Skip to content
GitLab
Menu
Why GitLab
Pricing
Contact Sales
Explore
Why GitLab
Pricing
Contact Sales
Explore
Sign in
Get free trial
Primary navigation
Search or go to…
Project
GitLab FOSS
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Privacy statement
Keyboard shortcuts
?
What's new
4
Snippets
Groups
Projects
Show more breadcrumbs
GitLab.org
GitLab FOSS
Commits
b565ee49
There was a problem fetching the pipeline summary.
Unverified
Commit
b565ee49
authored
7 years ago
by
Kamil Trzciński
Browse files
Options
Downloads
Patches
Plain Diff
Update documentation and expose ID
parent
140b51ce
No related branches found
No related tags found
Loading
Pipeline
#
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
doc/api/README.md
+1
-1
1 addition, 1 deletion
doc/api/README.md
doc/api/pipeline_triggers.md
+170
-0
170 additions, 0 deletions
doc/api/pipeline_triggers.md
lib/api/entities.rb
+1
-0
1 addition, 0 deletions
lib/api/entities.rb
with
172 additions
and
1 deletion
doc/api/README.md
+
1
−
1
View file @
b565ee49
...
...
@@ -12,7 +12,6 @@ following locations:
-
[
Branches
](
branches.md
)
-
[
Broadcast Messages
](
broadcast_messages.md
)
-
[
Builds
](
builds.md
)
-
[
Build Triggers
](
build_triggers.md
)
-
[
Build Variables
](
build_variables.md
)
-
[
Commits
](
commits.md
)
-
[
Deployments
](
deployments.md
)
...
...
@@ -33,6 +32,7 @@ following locations:
-
[
Notes
](
notes.md
)
(
comments
)
-
[
Notification settings
](
notification_settings.md
)
-
[
Pipelines
](
pipelines.md
)
-
[
Pipeline Triggers
](
pipeline_triggers.md
)
-
[
Projects
](
projects.md
)
including setting Webhooks
-
[
Project Access Requests
](
access_requests.md
)
-
[
Project Members
](
members.md
)
...
...
This diff is collapsed.
Click to expand it.
doc/api/
build
_triggers.md
→
doc/api/
pipeline
_triggers.md
+
170
−
0
View file @
b565ee49
#
Build
triggers
#
Pipeline
triggers
You can read more about
[
triggering
build
s through the API
](
../ci/triggers/README.md
)
.
You can read more about
[
triggering
pipeline
s through the API
](
../ci/triggers/README.md
)
.
## List project triggers
...
...
@@ -21,18 +21,14 @@ curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/
```
json
[
{
"created_at"
:
"2015-12-23T16:24:34.716Z"
,
"deleted_at"
:
null
,
"last_used"
:
"2016-01-04T15:41:21.986Z"
,
"token"
:
"fbdb730c2fbdb095a0862dbd8ab88b"
,
"updated_at"
:
"2015-12-23T16:24:34.716Z"
},
{
"created_at"
:
"2015-12-23T16:25:56.760Z"
,
"id"
:
10
,
"description"
:
"my trigger"
,
"created_at"
:
"2016-01-07T09:53:58.235Z"
,
"deleted_at"
:
null
,
"last_used"
:
null
,
"token"
:
"7b9148c158980bbd9bcea92c17522d"
,
"updated_at"
:
"2015-12-23T16:25:56.760Z"
"token"
:
"6d056f63e50fe6f8c5f8f4aa10edb7"
,
"updated_at"
:
"2016-01-07T09:53:58.235Z"
,
"owner"
:
null
}
]
```
...
...
@@ -42,7 +38,7 @@ curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/
Get details of project's build trigger.
```
GET /projects/:id/triggers/:t
oken
GET /projects/:id/triggers/:t
rigger_id
```
| Attribute | Type | required | Description |
...
...
@@ -51,42 +47,108 @@ GET /projects/:id/triggers/:token
|
`token`
| string | yes | The
`token`
of a trigger |
```
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers/
7b9148c158980bbd9bcea92c17522d
"
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers/
5
"
```
```
json
{
"created_at"
:
"2015-12-23T16:25:56.760Z"
,
"id"
:
10
,
"description"
:
"my trigger"
,
"created_at"
:
"2016-01-07T09:53:58.235Z"
,
"deleted_at"
:
null
,
"last_used"
:
null
,
"token"
:
"7b9148c158980bbd9bcea92c17522d"
,
"updated_at"
:
"2015-12-23T16:25:56.760Z"
"token"
:
"6d056f63e50fe6f8c5f8f4aa10edb7"
,
"updated_at"
:
"2016-01-07T09:53:58.235Z"
,
"owner"
:
null
}
```
## Create a project trigger
Create a
build
trigger for a project.
Create a trigger for a project.
```
POST /projects/:id/triggers
```
| Attribute | Type | required | Description |
|-----------|---------|----------|--------------------------|
|
`id`
| integer | yes | The ID of a project |
| Attribute | Type | required | Description |
|---------------|---------|----------|--------------------------|
|
`id`
| integer | yes | The ID of a project |
|
`description`
| string | yes | The trigger name |
```
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers"
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
-F description="my description"
"https://gitlab.example.com/api/v4/projects/1/triggers"
```
```
json
{
"id"
:
10
,
"description"
:
"my trigger"
,
"created_at"
:
"2016-01-07T09:53:58.235Z"
,
"deleted_at"
:
null
,
"last_used"
:
null
,
"token"
:
"6d056f63e50fe6f8c5f8f4aa10edb7"
,
"updated_at"
:
"2016-01-07T09:53:58.235Z"
"updated_at"
:
"2016-01-07T09:53:58.235Z"
,
"owner"
:
null
}
```
## Update a project trigger
Update a trigger for a project.
```
PUT /projects/:id/triggers/:trigger_id
```
| Attribute | Type | required | Description |
|---------------|---------|----------|--------------------------|
|
`trigger_id`
| integer | yes | The trigger id |
|
`description`
| string | no | The trigger name |
```
curl --request PUT -F description="my description" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers/10"
```
```
json
{
"id"
:
10
,
"description"
:
"my trigger"
,
"created_at"
:
"2016-01-07T09:53:58.235Z"
,
"deleted_at"
:
null
,
"last_used"
:
null
,
"token"
:
"6d056f63e50fe6f8c5f8f4aa10edb7"
,
"updated_at"
:
"2016-01-07T09:53:58.235Z"
,
"owner"
:
null
}
```
## Take ownership of a project trigger
Update an owner of a project trigger.
```
POST /projects/:id/triggers/:trigger_id/take
```
| Attribute | Type | required | Description |
|---------------|---------|----------|--------------------------|
|
`trigger_id`
| integer | yes | The trigger id |
```
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers/10/take"
```
```
json
{
"id"
:
10
,
"description"
:
"my trigger"
,
"created_at"
:
"2016-01-07T09:53:58.235Z"
,
"deleted_at"
:
null
,
"last_used"
:
null
,
"token"
:
"6d056f63e50fe6f8c5f8f4aa10edb7"
,
"updated_at"
:
"2016-01-07T09:53:58.235Z"
,
"owner"
:
null
}
```
...
...
@@ -95,14 +157,14 @@ curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitl
Remove a project's build trigger.
```
DELETE /projects/:id/triggers/:t
oken
DELETE /projects/:id/triggers/:t
rigger_id
```
| Attribute | Type | required | Description |
|-----------|---------|----------|--------------------------|
|
`id`
| integer | yes | The ID of a project |
|
`t
oken`
| string | yes | The
`token`
of a trigger
|
| Attribute
| Type | required | Description |
|-----------
-----
|---------|----------|--------------------------|
|
`id`
| integer | yes | The ID of a project |
|
`t
rigger_id`
| integer | yes | The trigger id
|
```
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers/
7b9148c158980bbd9bcea92c17522d
"
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers/
5
"
```
This diff is collapsed.
Click to expand it.
lib/api/entities.rb
+
1
−
0
View file @
b565ee49
...
...
@@ -639,6 +639,7 @@ class Build < Grape::Entity
end
class
Trigger
<
Grape
::
Entity
expose
:id
expose
:token
,
:description
expose
:created_at
,
:updated_at
,
:deleted_at
,
:last_used
expose
:owner
,
using:
Entities
::
UserBasic
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment