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
74b96326
Commit
74b96326
authored
Mar 01, 2016
by
Grzegorz Bizon
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update format of documentation for CI API
parent
ec7c6a08
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
40 additions
and
23 deletions
+40
-23
doc/ci/api/builds.md
doc/ci/api/builds.md
+19
-9
doc/ci/api/runners.md
doc/ci/api/runners.md
+21
-14
No files found.
doc/ci/api/builds.md
View file @
74b96326
...
@@ -8,35 +8,45 @@ communication channel. For the consumer API see the
...
@@ -8,35 +8,45 @@ communication channel. For the consumer API see the
## Authentication
## Authentication
Unique runner token is required to authenticate. You can provide build token
This API uses two types of authentication:
using a
`token`
parameter, or by sending
`BUILD-TOKEN`
header that contains it.
`token`
parameter and
`BUILD-TOKEN`
header can be interchangeable.
1.
Unique runner's token
Token assigned to runner after it has been registered.
2.
Using build authorization token
This is project's CI token that can be found in Continuous Integration
project settings.
Build authorization token can be passed as a parameter or a value of
`BUILD-TOKEN` header. This method are interchangeable.
## Builds
## Builds
### Runs oldest pending build by runner
### Runs oldest pending build by runner
POST /builds/register
POST /
ci/api/v1/
builds/register
Parameters:
Parameters:
*
`token`
(required) -
The unique token of runner
*
`token`
(required) -
Unique runner token
### Update details of an existing build
### Update details of an existing build
PUT /builds/:id
PUT /
ci/api/v1/
builds/:id
Parameters:
Parameters:
*
`id`
(required) - The ID of a project
*
`id`
(required) - The ID of a project
*
`token`
(required) - Unique runner token
*
`state`
(optional) - The state of a build
*
`state`
(optional) - The state of a build
*
`trace`
(optional) - The trace of a build
*
`trace`
(optional) - The trace of a build
### Upload artifacts to build
### Upload artifacts to build
POST /builds/:id/artifacts
POST /
ci/api/v1/
builds/:id/artifacts
Parameters:
Parameters:
...
@@ -46,7 +56,7 @@ Parameters:
...
@@ -46,7 +56,7 @@ Parameters:
### Download the artifacts file from build
### Download the artifacts file from build
GET /builds/:id/artifacts
GET /
ci/api/v1/
builds/:id/artifacts
Parameters:
Parameters:
...
@@ -55,7 +65,7 @@ Parameters:
...
@@ -55,7 +65,7 @@ Parameters:
### Remove the artifacts file from build
### Remove the artifacts file from build
DELETE /builds/:id/artifacts
DELETE /
ci/api/v1/
builds/:id/artifacts
Parameters:
Parameters:
...
...
doc/ci/api/runners.md
View file @
74b96326
# Runners API
# Runners API
API used by runners to register and delete
it
selves.
API used by runners to register and delete
them
selves.
_
**Note:**
This API is intended to be used only by Runners as their own
_
**Note:**
This API is intended to be used only by Runners as their own
communication channel. For the consumer API see the
communication channel. For the consumer API see the
[
new Runners API
](
../../api/runners.md
)
._
[
new Runners API
](
../../api/runners.md
)
._
## Authentication
This API uses two types of authentication:
1.
Unique runner's token
Token assigned to runner after it has been registered.
2.
Using runners' registration token
This is a token that can be found in project's settings.
It can be also found in Admin area » Runners settings.
There are two types of tokens you can pass - shared runner registration
token or project specific registration token.
## Runners
## Runners
### Register a new runner
### Register a new runner
__
Authentication is done with a shared runner registration token or a project
specific runner registration token.__
Used to make GitLab CI aware of available runners.
Used to make GitLab CI aware of available runners.
POST /runners/register
POST /
ci/api/v1/
runners/register
Parameters:
Parameters:
*
`token`
(required) -
The registration token.
*
`token`
(required) -
Registration token
It is 2 types of token you can pass here.
1.
Shared runner registration token
2.
Project specific registration token
### Delete a runner
### Delete a runner
__Authentication is done by using runner token.__
Used to remove runner.
Used to remove runner.
DELETE /runners/delete
DELETE /
ci/api/v1/
runners/delete
Parameters:
Parameters:
*
`token`
(required) -
The runner token.
*
`token`
(required) -
Unique runner token
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