summaryrefslogtreecommitdiff
path: root/doc/api/ci/README.md
blob: 96a281e27c8c3ac44319981df928ece351757328 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# GitLab CI API

## Purpose

The main purpose of GitLab CI API is to provide the necessary data and context
for GitLab CI Runners.

All relevant information about the consumer API can be found in a
[separate document](../../api/README.md).

## API Prefix

The current CI API prefix is `/ci/api/v1`.

You need to prepend this prefix to all examples in this documentation, like:

```bash
GET /ci/api/v1/builds/:id/artifacts
```

## Resources

- [Builds](builds.md)
- [Runners](runners.md)