diff options
author | Grzegorz Bizon <grzesiek.bizon@gmail.com> | 2016-02-04 14:03:47 +0300 |
---|---|---|
committer | Grzegorz Bizon <grzesiek.bizon@gmail.com> | 2016-02-19 19:24:59 +0300 |
commit | ec5c3c029ce220f5a1c0fd10d0d3bf17951a07c9 (patch) | |
tree | d928d8e61fdab2ce79593da17f96ab5bba0372d2 | |
parent | b14c9fcdbbc24f3d50c1c04091522470e64ccda9 (diff) |
Add API documentation for build erase endpoint
-rw-r--r-- | doc/api/builds.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/api/builds.md b/doc/api/builds.md index 43edb40e911..04128131165 100644 --- a/doc/api/builds.md +++ b/doc/api/builds.md @@ -338,3 +338,53 @@ Example of response "user": null } ``` + +## Erase a build + +Erase a single build of a project (remove build artifacts and a build trace) + +``` +DELETE /projects/:id/builds/:build_id/content +``` + +Parameters + +| Attribute | Type | required | Description | +|-----------|---------|----------|---------------------| +| `id` | integer | yes | The ID of a project | +| `build_id` | integer | yes | The ID of a build | + +Example of request + +``` +curl -X DELETE -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/builds/1/content" +``` + +Example of response + +```json +{ + "commit": { + "author_email": "admin@example.com", + "author_name": "Administrator", + "created_at": "2015-12-24T16:51:14.000+01:00", + "id": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd", + "message": "Test the CI integration.", + "short_id": "0ff3ae19", + "title": "Test the CI integration." + }, + "coverage": null, + "download_url": null, + "id": 69, + "name": "rubocop", + "ref": "master", + "runner": null, + "stage": "test", + "created_at": "2016-01-11T10:13:33.506Z", + "started_at": "2016-01-11T10:13:33.506Z", + "finished_at": "2016-01-11T10:15:10.506Z", + "status": "failed", + "tag": false, + "user": null +} +``` |