status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

website: document reason flag for http api

This commit is contained in:
Ryan Uber 2015-01-21 14:33:01 -08:00
parent 5aa69827f8
commit 52ff08b6c0
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
website/source/docs/agent/http/agent.html.markdown
View File

@ -195,6 +195,10 @@ persistent and will be automatically restored on agent restart.
The `?enable` flag is required, and its value must be `true` (to enter The `?enable` flag is required, and its value must be `true` (to enter
maintenance mode), or `false` (to resume normal operation). maintenance mode), or `false` (to resume normal operation).
The `?reason` flag is optional, and can contain a text string explaining the
reason for placing the node into maintenance mode. If no reason is provided,
a default value will be used instead.
The return code is 200 on success. The return code is 200 on success.
### <a name="agent_join"></a> /v1/agent/join/\<address\> ### <a name="agent_join"></a> /v1/agent/join/\<address\>
@ -355,4 +359,8 @@ on agent restart.
The `?enable` flag is required, and its value must be `true` (to enter The `?enable` flag is required, and its value must be `true` (to enter
maintenance mode), or `false` (to resume normal operation). maintenance mode), or `false` (to resume normal operation).
The `?reason` flag is optional, and can contain a text string explaining the
reason for placing the service into maintenance mode. If no reason is provided,
a default value will be used instead.
The return code is 200 on success. The return code is 200 on success.