open-nomad/website/pages/api-docs/system.mdx
Jeff Escalante 6c8f079d24
new website
2020-02-06 18:45:31 -05:00

60 lines
1.5 KiB
Plaintext

---
layout: api
page_title: System - HTTP API
sidebar_title: System
description: The /system endpoints are used for system maintenance.
---
# System HTTP API
The `/system` endpoints are used to for system maintenance and should not be
necessary for most users.
## Force GC
This endpoint initializes a garbage collection of jobs, evaluations, allocations, and
nodes. This is an asynchronous operation.
| Method | Path | Produces |
| ------ | --------------- | ------------------ |
| `PUT` | `/v1/system/gc` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api#blocking-queries) and
[required ACLs](/api#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
| `NO` | `management` |
### Sample Request
```shell
$ curl \
--request PUT \
https://localhost:4646/v1/system/gc
```
## Reconcile Summaries
This endpoint reconciles the summaries of all registered jobs.
| Method | Path | Produces |
| ------ | -------------------------------- | ------------------ |
| `PUT` | `/v1/system/reconcile/summaries` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api#blocking-queries) and
[required ACLs](/api#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
| `NO` | `management` |
### Sample Request
```shell
$ curl \
https://localhost:4646/v1/system/reconcile/summaries
```