summaryrefslogtreecommitdiff
path: root/doc/ci/api/README.md
blob: 94ef4d2c38d535f3d1b2c32518e5d021a2741d80 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# 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)
- [Commits](commits.md)