diff options
Diffstat (limited to 'doc/api/ci/README.md')
| -rw-r--r-- | doc/api/ci/README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/api/ci/README.md b/doc/api/ci/README.md new file mode 100644 index 00000000000..aea808007fc --- /dev/null +++ b/doc/api/ci/README.md @@ -0,0 +1,22 @@ +# GitLab CI API + +## 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. + +## 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 + +## Resources + +- [Builds](builds.md) +- [Runners](runners.md) |