2015-08-25 21:42:46 -04:00
|
|
|
# GitLab CI API
|
|
|
|
|
|
2016-02-29 04:20:45 -05:00
|
|
|
## Purpose
|
|
|
|
|
|
|
|
|
|
Main purpose of GitLab CI API is to provide necessary data and context for
|
|
|
|
|
GitLab CI Runners.
|
|
|
|
|
|
|
|
|
|
For consumer API take a look at this [documentation](../../api/README.md) where
|
|
|
|
|
you will find all relevant information.
|
|
|
|
|
|
2016-02-29 06:12:51 -05:00
|
|
|
## API Prefix
|
|
|
|
|
|
|
|
|
|
Current CI API prefix is `/ci/api/v1`.
|
|
|
|
|
|
|
|
|
|
You need to prepend this prefix to all examples in this documentation, like:
|
|
|
|
|
|
|
|
|
|
GET /ci/api/v1/builds/:id/artifacts
|
|
|
|
|
|
2015-08-25 21:42:46 -04:00
|
|
|
## Resources
|
|
|
|
|
|
2016-02-29 06:00:42 -05:00
|
|
|
- [Builds](builds.md)
|
2015-08-25 21:42:46 -04:00
|
|
|
- [Runners](runners.md)
|
|
|
|
|
- [Commits](commits.md)
|
