2017-05-26 23:17:44 +00:00
|
|
|
---
|
|
|
|
|
layout: api
|
|
|
|
|
page_title: System - HTTP API
|
2020-02-06 23:45:31 +00:00
|
|
|
description: The /system endpoints are used for system maintenance.
|
2017-05-26 23:17:44 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# System HTTP API
|
|
|
|
|
|
|
|
|
|
The `/system` endpoints are used to for system maintenance and should not be
|
|
|
|
|
necessary for most users.
|
|
|
|
|
|
|
|
|
|
## Force GC
|
|
|
|
|
|
2017-07-17 18:41:50 +00:00
|
|
|
This endpoint initializes a garbage collection of jobs, evaluations, allocations, and
|
2017-05-26 23:17:44 +00:00
|
|
|
nodes. This is an asynchronous operation.
|
|
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| ------ | --------------- | ------------------ |
|
|
|
|
|
| `PUT` | `/v1/system/gc` | `application/json` |
|
2017-05-26 23:17:44 +00:00
|
|
|
|
|
|
|
|
The table below shows this endpoint's support for
|
2020-03-20 22:24:56 +00:00
|
|
|
[blocking queries](/api-docs#blocking-queries) and
|
|
|
|
|
[required ACLs](/api-docs#acls).
|
2017-05-26 23:17:44 +00:00
|
|
|
|
2017-05-31 00:31:16 +00:00
|
|
|
| Blocking Queries | ACL Required |
|
|
|
|
|
| ---------------- | ------------ |
|
2017-10-10 17:51:38 +00:00
|
|
|
| `NO` | `management` |
|
2017-05-26 23:17:44 +00:00
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-18 20:53:06 +00:00
|
|
|
```shell-session
|
|
|
|
|
$ curl \
|
2017-05-26 23:17:44 +00:00
|
|
|
--request PUT \
|
2018-01-29 16:27:52 +00:00
|
|
|
https://localhost:4646/v1/system/gc
|
2017-05-26 23:17:44 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Reconcile Summaries
|
|
|
|
|
|
|
|
|
|
This endpoint reconciles the summaries of all registered jobs.
|
|
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| ------ | -------------------------------- | ------------------ |
|
|
|
|
|
| `PUT` | `/v1/system/reconcile/summaries` | `application/json` |
|
2017-05-26 23:17:44 +00:00
|
|
|
|
|
|
|
|
The table below shows this endpoint's support for
|
2020-03-20 22:24:56 +00:00
|
|
|
[blocking queries](/api-docs#blocking-queries) and
|
|
|
|
|
[required ACLs](/api-docs#acls).
|
2017-05-26 23:17:44 +00:00
|
|
|
|
2017-05-31 00:31:16 +00:00
|
|
|
| Blocking Queries | ACL Required |
|
|
|
|
|
| ---------------- | ------------ |
|
2017-10-10 17:51:38 +00:00
|
|
|
| `NO` | `management` |
|
2020-02-06 23:45:31 +00:00
|
|
|
|
2017-05-26 23:17:44 +00:00
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-18 20:53:06 +00:00
|
|
|
```shell-session
|
|
|
|
|
$ curl \
|
2018-01-29 16:27:52 +00:00
|
|
|
https://localhost:4646/v1/system/reconcile/summaries
|
2017-05-26 23:17:44 +00:00
|
|
|
```
|
