root/docs/operation/wire/checks/show.xml

Revision 46d766e7a7e64b0d0718f552ab01b9ba486892c5, 1.9 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 2 years ago)

split out the rest doc to make adding new docs less intimidating

  • Property mode set to 100644
Line 
1 <?xml version="1.0"?>
2 <section>
3 <title>/checks/show/</title>
4   <variablelist>
5     <varlistentry>
6       <term>method</term>
7       <listitem><code>GET</code></listitem>
8     </varlistentry>
9     <varlistentry>
10       <term>uri</term>
11       <listitem><code>/checks/show/&lt;path/&gt;&lt;checkid&gt;</code></listitem>
12     </varlistentry>
13   </variablelist>
14   <para>
15   This call returns an XML document describing the current configuration and
16   state of the specific check.  The <code>checkid</code> specified is located
17   under the optional <code>path</code>.  If the check exists, but it under
18   another path, a HTTP 403 code is returned.  If the check does not exist,
19   a HTTP 404 code is returned.
20   </para>
21
22   <example>
23     <title>REST /checks/show XML output.</title>
24     <para>Output from an HTTP GET of <code>/checks/show/1b4e28ba-2fa1-11d2-883f-b9a761bde3aa</code></para>
25     <programlisting><![CDATA[
26 <?xml version="1.0" encoding="utf8"?>
27 <check>
28   <attributes>
29     <uuid>1b4e28ba-2fa1-11d2-883f-b9a761bde3aa</uuid>
30     <name>http</name>
31     <module inherited="/dc1/web/@module">http</module>
32     <target>8.8.38.5</target>
33     <period inherited="/dc1/@period">60000</period>
34     <timeout inherited="/dc1/@timeout">5000</timeout>
35     <filterset inherited="/@filterset">default</filterset>
36   </attributes>
37   <config>
38     <code>200</code>
39     <url>https://labs.omniti.com/</url>
40   </config>
41   <state>
42     <running>false</running>
43     <killed>false</killed>
44     <configured>true</configured>
45     <disabled>false</disabled>
46     <last_run now="1253124365.131">1253124339.270</last_run>
47     <runtime>4.408</runtime>
48     <availability>available</availability>
49     <state>good</state>
50     <status>code=200,rt=4.409s,bytes=8958</status>
51     <metrics>
52       <duration type="I">4408</duration>
53       <code type="s">200</code>
54       <bytes type="i">8958</bytes>
55     </metrics>
56   </state>
57 </check>
58     ]]></programlisting>
59   </example>
60 </section>
Note: See TracBrowser for help on using the browser.