summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorMark Fletcher <mark@gitlab.com>2017-02-21 20:21:31 +0530
committerMark Fletcher <mark@gitlab.com>2017-02-22 17:40:20 +0530
commitd3425933dddf4e849199c06dd3ce00c212d0c6da (patch)
treee285f3bec6463b2c29ba446856438836975d924c /doc/api
parent459a97d46812fecc59c973bad356935422c7f60e (diff)
downloadgitlab-ce-d3425933dddf4e849199c06dd3ce00c212d0c6da.tar.gz
Add housekeeping endpoint for Projects API
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/projects.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md
index e9ef03a0c0c..872f570e0f6 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -1195,3 +1195,17 @@ Parameters:
| `query` | string | yes | A string contained in the project name |
| `order_by` | string | no | Return requests ordered by `id`, `name`, `created_at` or `last_activity_at` fields |
| `sort` | string | no | Return requests sorted in `asc` or `desc` order |
+
+## Start the Housekeeping task for a Project
+
+>**Note:** This feature was introduced in GitLab 9.0
+
+```
+POST /projects/:id/housekeeping
+```
+
+Parameters:
+
+| Attribute | Type | Required | Description |
+| --------- | ---- | -------- | ----------- |
+| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |