2016-02-24 23:38:32 +00:00
|
|
|
---
|
|
|
|
|
layout: "http"
|
|
|
|
|
page_title: "HTTP API: /v1/system/"
|
|
|
|
|
sidebar_current: "docs-http-system"
|
|
|
|
|
description: |-
|
2016-03-15 18:28:31 +00:00
|
|
|
The '/1/system/' endpoints are used to for system maintenance.
|
2016-02-24 23:38:32 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# /v1/system
|
|
|
|
|
|
2016-03-15 18:28:31 +00:00
|
|
|
The `system` endpoint is used to for system maintenance and should not be
|
2016-02-24 23:38:32 +00:00
|
|
|
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>
|
2016-03-01 17:40:39 +00:00
|
|
|
<dd>PUT</dd>
|
2016-02-24 23:38:32 +00:00
|
|
|
|
|
|
|
|
<dt>URL</dt>
|
|
|
|
|
<dd>`/v1/system/gc`</dd>
|
|
|
|
|
|
|
|
|
|
<dt>Parameters</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
None
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt>Returns</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
None
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
