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

website: improve the docs for the agent TTL endpoints

This commit is contained in:
Armon Dadgar 2014-05-06 10:44:37 -07:00
parent 219cbd62f7
commit 58a896ad28
1 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -323,24 +323,33 @@ The return code is 200 on success.
### /v1/agent/check/pass/\<checkId\> ### /v1/agent/check/pass/\<checkId\>
This endpoint is used with a check that is of the [TTL type](/docs/agent/checks.html). This endpoint is used with a check that is of the [TTL type](/docs/agent/checks.html).
When this endpoint is accessed, the status of the check is set to "passing", and When this endpoint is accessed via a GET, the status of the check is set to "passing",
the TTL clock is reset. and the TTL clock is reset.
The optional "?node=" query parameter can be used to associate output with
the status of the check. This should be human readable for operators.
The return code is 200 on success. The return code is 200 on success.
### /v1/agent/check/warn/\<checkId\> ### /v1/agent/check/warn/\<checkId\>
This endpoint is used with a check that is of the [TTL type](/docs/agent/checks.html). This endpoint is used with a check that is of the [TTL type](/docs/agent/checks.html).
When this endpoint is accessed, the status of the check is set to "warning", and When this endpoint is accessed via a GET, the status of the check is set to "warning",
the TTL clock is reset. and the TTL clock is reset.
The optional "?node=" query parameter can be used to associate output with
the status of the check. This should be human readable for operators.
The return code is 200 on success. The return code is 200 on success.
### /v1/agent/check/fail/\<checkId\> ### /v1/agent/check/fail/\<checkId\>
This endpoint is used with a check that is of the [TTL type](/docs/agent/checks.html). This endpoint is used with a check that is of the [TTL type](/docs/agent/checks.html).
When this endpoint is accessed, the status of the check is set to "critical", and When this endpoint is accessed via a GET, the status of the check is set to "critical",
the TTL clock is reset. and the TTL clock is reset.
The optional "?node=" query parameter can be used to associate output with
the status of the check. This should be human readable for operators.
The return code is 200 on success. The return code is 200 on success.