add documentation for system gc endpoint and update log docs

This commit is contained in:
Alex Dadgar
2016-02-24 15:38:32 -08:00
parent 7f4140758e
commit 076e1bb615
3 changed files with 53 additions and 11 deletions

View File

@@ -0,0 +1,38 @@
---
layout: "http"
page_title: "HTTP API: /v1/system/"
sidebar_current: "docs-http-system"
description: |-
The '/1/system/' endpoints are used to for system maintance.
---
# /v1/system
The `system` endpoint is used to for system maintance and should not be
necessary for most users. By default, the agent's local region is used; another
region can be specified using the `?region=` query parameter.
## PUT
<dl>
<dt>Description</dt>
<dd>
Initiate garbage collection of jobs, evals, allocations and nodes.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dt>URL</dt>
<dd>`/v1/system/gc`</dd>
<dt>Parameters</dt>
<dd>
None
</dd>
<dt>Returns</dt>
<dd>
None
</dd>
</dl>