Added docs for the purge API
This commit is contained in:
parent
2868389c25
commit
42e4118f81
|
@ -614,3 +614,48 @@ $ curl \
|
|||
"KnownLeader": false
|
||||
}
|
||||
```
|
||||
|
||||
## Purge Node
|
||||
|
||||
This endpoint purges a node from the system. Nodes can still join the cluster if
|
||||
they are alive.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| ------- | ------------------------- | -------------------------- |
|
||||
| `POST` | `/v1/node/:node_id/purge` | `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` |
|
||||
|
||||
### Parameters
|
||||
|
||||
- `:node_id` `(string: <required>)`- Specifies the UUID of the node. This must
|
||||
be the full UUID, not the short 8-character one. This is specified as part of
|
||||
the path.
|
||||
|
||||
### Sample Request
|
||||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/node/fb2170a8-257d-3c64-b14d-bc06cc94e34c/purge
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
||||
```json
|
||||
{
|
||||
"EvalIDs": [
|
||||
"253ec083-22a7-76c9-b8b6-2bf3d4b27bfb"
|
||||
],
|
||||
"EvalCreateIndex": 91,
|
||||
"NodeModifyIndex": 90,
|
||||
"Index": 90,
|
||||
"LastContact": 0,
|
||||
"KnownLeader": false
|
||||
}
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue