summaryrefslogtreecommitdiff
path: root/doc/api/builds.md
diff options
context:
space:
mode:
authorMark Fletcher <mark@gitlab.com>2016-06-03 18:56:26 +0100
committerMark Fletcher <mark@gitlab.com>2016-06-03 18:56:26 +0100
commit2e8f039ae91767b912da2511d7697d7993293534 (patch)
tree2f64e73b952f7808e1174c5beaf975cde54f547c /doc/api/builds.md
parente696795a42ccb69d0d29300db7a12c3ee3b1fd35 (diff)
downloadgitlab-ce-2e8f039ae91767b912da2511d7697d7993293534.tar.gz
Document the API endpoint for gathering a build log
* Resolves #18015
Diffstat (limited to 'doc/api/builds.md')
-rw-r--r--doc/api/builds.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/api/builds.md b/doc/api/builds.md
index 4c0a47d1ea0..5669bd0cdda 100644
--- a/doc/api/builds.md
+++ b/doc/api/builds.md
@@ -278,6 +278,30 @@ Response:
[ce-2893]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2893
+## Get a trace file
+
+Get a trace of a specific build of a project
+
+```
+GET /projects/:id/builds/:build_id/trace
+```
+
+| Attribute | Type | Required | Description |
+|------------|---------|----------|---------------------|
+| id | integer | yes | The ID of a project |
+| build_id | integer | yes | The ID of a build |
+
+```
+curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/builds/8/trace"
+```
+
+Response:
+
+| Status | Description |
+|-----------|-----------------------------------|
+| 200 | Serves the trace file |
+| 404 | Build not found or no trace file |
+
## Cancel a build
Cancel a single build of a project