summaryrefslogtreecommitdiff
path: root/doc/ci/api/runners.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ci/api/runners.md')
-rw-r--r--doc/ci/api/runners.md73
1 files changed, 21 insertions, 52 deletions
diff --git a/doc/ci/api/runners.md b/doc/ci/api/runners.md
index c383dc4bcc9..2f01da4bd76 100644
--- a/doc/ci/api/runners.md
+++ b/doc/ci/api/runners.md
@@ -1,77 +1,46 @@
# Runners API
-## Runners
+API used by runners to register and delete themselves.
-### Retrieve all runners
+_**Note:** This API is intended to be used only by Runners as their own
+communication channel. For the consumer API see the
+[new Runners API](../../api/runners.md)._
-__Authentication is done by GitLab user token & GitLab url__
+## Authentication
-Used to get information about all runners registered on the GitLab CI
-instance.
+This API uses two types of authentication:
- GET /ci/runners
+1. Unique runner's token
-Returns:
+ Token assigned to runner after it has been registered.
-```json
-[
- {
- "id" : 85,
- "token" : "12b68e90394084703135"
- },
- {
- "id" : 86,
- "token" : "76bf894e969364709864"
- },
-]
-```
+2. Using runners' registration token
-### Register a new runner
+ 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
-__Authentication is done with a Shared runner registration token or a project Specific runner registration token__
+### Register a new runner
Used to make GitLab CI aware of available runners.
- POST /ci/runners/register
+ POST /ci/api/v1/runners/register
Parameters:
- * `token` (required) - The registration token. It is 2 types of token you can pass here.
-
-1. Shared runner registration token
-2. Project specific registration token
+ * `token` (required) - Registration token
-Returns:
-
-```json
-{
- "id" : 85,
- "token" : "12b68e90394084703135"
-}
-```
### Delete a runner
+Used to remove runner.
-__Authentication is done by runner token__
-
-Used to removing runners.
-
- DELETE /ci/runners/delete
+ DELETE /ci/api/v1/runners/delete
Parameters:
- * `token` (required) - The runner token.
-
-Returns:
-
-```json
-{
- "id" : 1,
- "token" : "d14963981a428f70121777e50643d1",
- "created_at" : "2015-02-26T11:39:39.232Z",
- "updated_at" : "2015-02-26T11:39:39.232Z",
- "description" : "awesome runner"
-}
-``` \ No newline at end of file
+ * `token` (required) - Unique runner token