2016-06-09 12:32:17 -04:00
|
|
|
# GitLab CI API
|
|
|
|
|
|
|
|
|
|
## Purpose
|
|
|
|
|
|
2016-06-14 08:50:25 -04:00
|
|
|
The main purpose of GitLab CI API is to provide the necessary data and context
|
|
|
|
|
for GitLab CI Runners.
|
2016-06-09 12:32:17 -04:00
|
|
|
|
2016-06-14 08:50:25 -04:00
|
|
|
All relevant information about the consumer API can be found in a
|
|
|
|
|
[separate document](../../api/README.md).
|
2016-06-09 12:32:17 -04:00
|
|
|
|
|
|
|
|
## API Prefix
|
|
|
|
|
|
2016-06-14 08:50:25 -04:00
|
|
|
The current CI API prefix is `/ci/api/v1`.
|
2016-06-09 12:32:17 -04:00
|
|
|
|
|
|
|
|
You need to prepend this prefix to all examples in this documentation, like:
|
|
|
|
|
|
2016-06-14 08:50:25 -04:00
|
|
|
```bash
|
|
|
|
|
GET /ci/api/v1/builds/:id/artifacts
|
|
|
|
|
```
|
2016-06-09 12:32:17 -04:00
|
|
|
|
|
|
|
|
## Resources
|
|
|
|
|
|
|
|
|
|
- [Builds](builds.md)
|
|
|
|
|
- [Runners](runners.md)
|
