open-nomad/website/source/api/system.html.md

60 lines
1.6 KiB
Markdown
Raw Normal View History

2017-05-26 23:17:44 +00:00
---
layout: api
page_title: System - HTTP API
sidebar_current: api-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
2017-05-26 23:17:44 +00:00
nodes. This is an asynchronous operation.
| Method | Path | Produces |
| ------ | ---------------------------| -------------------------- |
| `PUT` | `/v1/system/gc` | `application/json` |
The table below shows this endpoint's support for
2017-05-31 01:08:23 +00:00
[blocking queries](/api/index.html#blocking-queries) and
2017-05-26 23:17:44 +00:00
[required ACLs](/api/index.html#acls).
2017-05-31 00:31:16 +00:00
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
| `NO` | `management` |
2017-05-26 23:17:44 +00:00
### Sample Request
```text
$ curl \
--request PUT \
https://nomad.rocks/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
2017-05-31 01:08:23 +00:00
[blocking queries](/api/index.html#blocking-queries) and
2017-05-26 23:17:44 +00:00
[required ACLs](/api/index.html#acls).
2017-05-31 00:31:16 +00:00
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
| `NO` | `management` |
2017-05-26 23:17:44 +00:00
### Sample Request
```text
$ curl \
https://nomad.rocks/v1/system/reconcile/summaries
```