luxolus/open-nomad
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity

Document /v1/client/gc endpoint

Browse source
This commit is contained in:
Michael Schurter 2017-10-09 11:27:28 -07:00
parent 44455f5e93
commit dce2479147
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
website/source/api/client.html.md
View file

@ -560,3 +560,28 @@ $ curl \
"ModTime": "2016-03-15T15:40:56.822238153-07:00"
}
```
## GC Allocation
This endpoint forces a garbage collection of all stopped allocations on a node.
The API endpoint is hosted by the Nomad client and requests have to be made to
the Nomad client whose allocations should be garbage collected.
| Method | Path | Produces |
| ------ | ---------------------------- | -------------------------- |
| `GET` | `/client/gc` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api/index.html#blocking-queries) and
[required ACLs](/api/index.html#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
| `NO` | `node:write` |
### Sample Request
```text
$ curl \
https://nomad.rocks/v1/client/gc
```