Merge pull request #2692 from Toady00/patch-1

Specify PUT for agent maintenance endpoint
This commit is contained in:
James Phillips 2017-02-01 06:58:20 -08:00 committed by GitHub
commit 9ef05bd759
1 changed files with 5 additions and 4 deletions

View File

@ -220,10 +220,11 @@ The return code is 200 on success.
### <a name="agent_maintenance"></a> /v1/agent/maintenance ### <a name="agent_maintenance"></a> /v1/agent/maintenance
The node maintenance endpoint can place the agent into "maintenance mode". The node maintenance endpoint is hit with a PUT and is used to place the agent
During maintenance mode, the node will be marked as unavailable and will not be into "maintenance mode". During maintenance mode, the node will be marked as
present in DNS or API queries. This API call is idempotent. Maintenance mode is unavailable and will not be present in DNS or API queries. This API call is
persistent and will be automatically restored on agent restart. idempotent. Maintenance mode is persistent and will be automatically restored
on agent restart.
The `?enable` flag is required. Acceptable values are either `true` (to enter The `?enable` flag is required. Acceptable values are either `true` (to enter
maintenance mode) or `false` (to resume normal operation). maintenance mode) or `false` (to resume normal operation).