€cdocutils.nodes
document
q)q}q(U	nametypesq}q(X   infoqNX   list all possible check typesqNX   update and delete checkqNX   check typesq	NX   setupq
NX   create a checkqNX   test existing checkqNX   list checksqNX
   attributesqNX!   attributes used for remote checksqNX   checksqNX   test parameters (before create)qNuUsubstitution_defsq}qUparse_messagesq]q(cdocutils.nodes
system_message
q)q}q(U	rawsourceqU Uparentqcdocutils.nodes
section
q)q}q(hU U
referencedqKhh)q}q (hU hhUsourceq!XM   /Users/jamie/projects/php/php-opencloud/doc/services/monitoring/Checks.md.rstq"Utagnameq#Usectionq$U
attributesq%}q&(Udupnamesq']Uclassesq(]Ubackrefsq)]Uidsq*]q+Ucheck-typesq,aUnamesq-]q.h	auUlineq/KŠUdocumentq0hUchildrenq1]q2(cdocutils.nodes
title
q3)q4}q5(hX   Check typesq6hhh!h"h#Utitleq7h%}q8(h']h(]h)]h*]h-]uh/KŠh0hh1]q9cdocutils.nodes
Text
q:X   Check typesq;…q<}q=(hh6hh4ubaubhh)q>}q?(hU hKhhh!h"h#h$h%}q@(h']qAX   setupqBah(]h)]h*]qCUid2qDah-]uh/K¬h0hh1]qE(h3)qF}qG(hX   SetupqHhh>h!h"h#h7h%}qI(h']h(]h)]h*]h-]uh/K¬h0hh1]qJh:X   SetupqK…qL}qM(hhHhhFubaubcdocutils.nodes
paragraph
qN)qO}qP(hX2   If you want to see the type for an existing Check:qQhh>h!h"h#U	paragraphqRh%}qS(h']h(]h)]h*]h-]uh/K®h0hh1]qTh:X2   If you want to see the type for an existing Check:qU…qV}qW(hhQhhOubaubcdocutils.nodes
literal_block
qX)qY}qZ(hX^   /** @var \OpenCloud\CloudMonitoring\Resource\CheckType */
$checkType = $check->getCheckType();hh>h!h"h#Uliteral_blockq[h%}q\(U	xml:spaceq]Upreserveq^h*]h)]h']h(]q_(Ucodeq`X   phpqaeh-]uh/K´h0hh1]qbcdocutils.nodes
inline
qc)qd}qe(hX^   /** @var \OpenCloud\CloudMonitoring\Resource\CheckType */
$checkType = $check->getCheckType();h%}qf(h']h(]qgUotherqhah)]h*]h-]uhhYh1]qih:X^   /** @var \OpenCloud\CloudMonitoring\Resource\CheckType */
$checkType = $check->getCheckType();qj…qk}ql(hU hhdubah#UinlineqmubaubhN)qn}qo(hX@   Alternatively, you can retrieve a specific type based on its ID:qphh>h!h"h#hRh%}qq(h']h(]h)]h*]h-]uh/Kµh0hh1]qrh:X@   Alternatively, you can retrieve a specific type based on its ID:qs…qt}qu(hhphhnubaubhX)qv}qw(hXO   $checkTypeId = 'remote.dns';
$checkType = $service->getCheckType($checkTypeId);hh>h!h"h#h[h%}qx(h]h^h*]h)]h']h(]qy(h`X   phpqzeh-]uh/K»h0hh1]q{hc)q|}q}(hXO   $checkTypeId = 'remote.dns';
$checkType = $service->getCheckType($checkTypeId);h%}q~(h']h(]qUotherq€ah)]h*]h-]uhhvh1]qh:XO   $checkTypeId = 'remote.dns';
$checkType = $service->getCheckType($checkTypeId);q‚…qƒ}q„(hU hh|ubah#hmubaubeubh)q…}q†(hU hKhhh!h"h#h$h%}q‡(h']qˆX
   attributesq‰ah(]h)]h*]qŠUid3q‹ah-]uh/K½h0hh1]qŒ(h3)q}qŽ(hX
   Attributesqhh…h!h"h#h7h%}q(h']h(]h)]h*]h-]uh/K½h0hh1]q‘h:X
   Attributesq’…q“}q”(hhhhubaubcdocutils.nodes
table
q•)q–}q—(hU hh…h!h"h#Utableq˜h%}q™(h']h(]h)]h*]h-]uh/Nh0hh1]qšcdocutils.nodes
tgroup
q›)qœ}q(hU h%}qž(h*]h)]h']h(]h-]UcolsKuhh–h1]qŸ(cdocutils.nodes
colspec
q )q¡}q¢(hU h%}q£(h*]h)]h']h(]h-]UcolwidthKuhhœh1]h#Ucolspecq¤ubh )q¥}q¦(hU h%}q§(h*]h)]h']h(]h-]UcolwidthKºuhhœh1]h#h¤ubh )q¨}q©(hU h%}qª(h*]h)]h']h(]h-]UcolwidthKuhhœh1]h#h¤ubh )q«}q¬(hU h%}q­(h*]h)]h']h(]h-]UcolwidthKuhhœh1]h#h¤ubcdocutils.nodes
thead
q®)q¯}q°(hU h%}q±(h']h(]h)]h*]h-]uhhœh1]q²cdocutils.nodes
row
q³)q´}qµ(hU h%}q¶(h']h(]h)]h*]h-]uhh¯h1]q·(cdocutils.nodes
entry
q¸)q¹}qº(hU h%}q»(h']h(]h)]h*]h-]uhh´h1]q¼hN)q½}q¾(hX   Nameq¿hh¹h!h"h#hRh%}qÀ(h']h(]h)]h*]h-]uh/KÀh1]qÁh:X   NameqÂ…qÃ}qÄ(hh¿hh½ubaubah#UentryqÅubh¸)qÆ}qÇ(hU h%}qÈ(h']h(]h)]h*]h-]uhh´h1]qÉhN)qÊ}qË(hX   DescriptionqÌhhÆh!h"h#hRh%}qÍ(h']h(]h)]h*]h-]uh/KÀh1]qÎh:X   DescriptionqÏ…qÐ}qÑ(hhÌhhÊubaubah#hÅubh¸)qÒ}qÓ(hU h%}qÔ(h']h(]h)]h*]h-]uhh´h1]qÕhN)qÖ}q×(hX	   Data typeqØhhÒh!h"h#hRh%}qÙ(h']h(]h)]h*]h-]uh/KÀh1]qÚh:X	   Data typeqÛ…qÜ}qÝ(hhØhhÖubaubah#hÅubh¸)qÞ}qß(hU h%}qà(h']h(]h)]h*]h-]uhh´h1]qáhN)qâ}qã(hX   MethodqähhÞh!h"h#hRh%}qå(h']h(]h)]h*]h-]uh/KÀh1]qæh:X   Methodqç…qè}qé(hhähhâubaubah#hÅubeh#Urowqêubah#Utheadqëubcdocutils.nodes
tbody
qì)qí}qî(hU h%}qï(h']h(]h)]h*]h-]uhhœh1]qð(h³)qñ}qò(hU h%}qó(h']h(]h)]h*]h-]uhhíh1]qô(h¸)qõ}qö(hU h%}q÷(h']h(]h)]h*]h-]uhhñh1]qøhN)qù}qú(hX   typeqûhhõh!h"h#hRh%}qü(h']h(]h)]h*]h-]uh/KÂh1]qýh:X   typeqþ…qÿ}r   (hhûhhùubaubah#hÅubh¸)r  }r  (hU h%}r  (h']h(]h)]h*]h-]uhhñh1]r  hN)r  }r  (hX%   The name of the supported check type.r  hj  h!h"h#hRh%}r  (h']h(]h)]h*]h-]uh/KÂh1]r	  h:X%   The name of the supported check type.r
  …r  }r  (hj  hj  ubaubah#hÅubh¸)r  }r  (hU h%}r  (h']h(]h)]h*]h-]uhhñh1]r  hN)r  }r  (hX   Stringr  hj  h!h"h#hRh%}r  (h']h(]h)]h*]h-]uh/KÂh1]r  h:X   Stringr  …r  }r  (hj  hj  ubaubah#hÅubh¸)r  }r  (hU h%}r  (h']h(]h)]h*]h-]uhhñh1]r  hN)r  }r  (hX   ``getType()``r  hj  h!h"h#hRh%}r   (h']h(]h)]h*]h-]uh/KÂh1]r!  cdocutils.nodes
literal
r"  )r#  }r$  (hj  h%}r%  (h']h(]h)]h*]h-]uhj  h1]r&  h:X	   getType()r'  …r(  }r)  (hU hj#  ubah#Uliteralr*  ubaubah#hÅubeh#hêubh³)r+  }r,  (hU h%}r-  (h']h(]h)]h*]h-]uhhíh1]r.  (h¸)r/  }r0  (hU h%}r1  (h']h(]h)]h*]h-]uhj+  h1]r2  hN)r3  }r4  (hX   fieldsr5  hj/  h!h"h#hRh%}r6  (h']h(]h)]h*]h-]uh/KÄh1]r7  h:X   fieldsr8  …r9  }r:  (hj5  hj3  ubaubah#hÅubh¸)r;  }r<  (hU h%}r=  (h']h(]h)]h*]h-]uhj+  h1]r>  hN)r?  }r@  (hX   Check type fields.rA  hj;  h!h"h#hRh%}rB  (h']h(]h)]h*]h-]uh/KÄh1]rC  h:X   Check type fields.rD  …rE  }rF  (hjA  hj?  ubaubah#hÅubh¸)rG  }rH  (hU h%}rI  (h']h(]h)]h*]h-]uhj+  h1]rJ  hN)rK  }rL  (hX   ArrayrM  hjG  h!h"h#hRh%}rN  (h']h(]h)]h*]h-]uh/KÄh1]rO  h:X   ArrayrP  …rQ  }rR  (hjM  hjK  ubaubah#hÅubh¸)rS  }rT  (hU h%}rU  (h']h(]h)]h*]h-]uhj+  h1]rV  hN)rW  }rX  (hX   ``getFields()``rY  hjS  h!h"h#hRh%}rZ  (h']h(]h)]h*]h-]uh/KÄh1]r[  j"  )r\  }r]  (hjY  h%}r^  (h']h(]h)]h*]h-]uhjW  h1]r_  h:X   getFields()r`  …ra  }rb  (hU hj\  ubah#j*  ubaubah#hÅubeh#hêubh³)rc  }rd  (hU h%}re  (h']h(]h)]h*]h-]uhhíh1]rf  (h¸)rg  }rh  (hU h%}ri  (h']h(]h)]h*]h-]uhjc  h1]rj  hN)rk  }rl  (hX   supported\_platformshjg  h!h"h#hRh%}rm  (h']h(]h)]h*]h-]uh/KÆh1]rn  h:X   supported_platformsro  …rp  }rq  (hX   supported\_platformshjk  ubaubah#hÅubh¸)rr  }rs  (hU h%}rt  (h']h(]h)]h*]h-]uhjc  h1]ru  hN)rv  }rw  (hX¶   Platforms on which an agent check type is supported. This is advisory information only - the check may still work on other platforms, or report that check execution failed at runtimerx  hjr  h!h"h#hRh%}ry  (h']h(]h)]h*]h-]uh/KÆh1]rz  h:X¶   Platforms on which an agent check type is supported. This is advisory information only - the check may still work on other platforms, or report that check execution failed at runtimer{  …r|  }r}  (hjx  hjv  ubaubah#hÅubh¸)r~  }r  (hU h%}r€  (h']h(]h)]h*]h-]uhjc  h1]r  hN)r‚  }rƒ  (hX   Arrayr„  hj~  h!h"h#hRh%}r…  (h']h(]h)]h*]h-]uh/KÆh1]r†  h:X   Arrayr‡  …rˆ  }r‰  (hj„  hj‚  ubaubah#hÅubh¸)rŠ  }r‹  (hU h%}rŒ  (h']h(]h)]h*]h-]uhjc  h1]r  hN)rŽ  }r  (hX   ``getSupportedPlatforms()``r  hjŠ  h!h"h#hRh%}r‘  (h']h(]h)]h*]h-]uh/KÆh1]r’  j"  )r“  }r”  (hj  h%}r•  (h']h(]h)]h*]h-]uhjŽ  h1]r–  h:X   getSupportedPlatforms()r—  …r˜  }r™  (hU hj“  ubah#j*  ubaubah#hÅubeh#hêubeh#Utbodyrš  ubeh#Utgroupr›  ubaubeubh)rœ  }r  (hU hhh!h"h#h$h%}rž  (h']h(]h)]h*]rŸ  Ulist-all-possible-check-typesr   ah-]r¡  hauh/KÊh0hh1]r¢  (h3)r£  }r¤  (hX   List all possible check typesr¥  hjœ  h!h"h#h7h%}r¦  (h']h(]h)]h*]h-]uh/KÊh0hh1]r§  h:X   List all possible check typesr¨  …r©  }rª  (hj¥  hj£  ubaubhX)r«  }r¬  (hXn   $checkTypes = $service->getCheckTypes();

foreach ($checkTypes as $checkType) {
   echo $checkType->getId();
}hjœ  h!h"h#h[h%}r­  (h]h^h*]h)]h']h(]r®  (h`X   phpr¯  eh-]uh/KÓh0hh1]r°  hc)r±  }r²  (hXn   $checkTypes = $service->getCheckTypes();

foreach ($checkTypes as $checkType) {
   echo $checkType->getId();
}h%}r³  (h']h(]r´  Uotherrµ  ah)]h*]h-]uhj«  h1]r¶  h:Xn   $checkTypes = $service->getCheckTypes();

foreach ($checkTypes as $checkType) {
   echo $checkType->getId();
}r·  …r¸  }r¹  (hU hj±  ubah#hmubaubeubeubh!h"h#h$h%}rº  (h']r»  X   infor¼  ah(]h)]h*]r½  Uid1r¾  ah-]uh/Kh0hh1]r¿  (h3)rÀ  }rÁ  (hX   InforÂ  hhh!h"h#h7h%}rÃ  (h']h(]h)]h*]h-]uh/Kh0hh1]rÄ  h:X   InforÅ  …rÆ  }rÇ  (hjÂ  hjÀ  ubaubhN)rÈ  }rÉ  (hXÞ   Each check within the Rackspace Cloud Monitoring has a designated check
type. The check type instructs the monitoring system how to check the
monitored resource. **Note:** Users cannot create, update or delete
check types.hhh!h"h#hRh%}rÊ  (h']h(]h)]h*]h-]uh/Kh0hh1]rË  (h:X¢   Each check within the Rackspace Cloud Monitoring has a designated check
type. The check type instructs the monitoring system how to check the
monitored resource. rÌ  …rÍ  }rÎ  (hX¢   Each check within the Rackspace Cloud Monitoring has a designated check
type. The check type instructs the monitoring system how to check the
monitored resource. hjÈ  ubcdocutils.nodes
strong
rÏ  )rÐ  }rÑ  (hX	   **Note:**h%}rÒ  (h']h(]h)]h*]h-]uhjÈ  h1]rÓ  h:X   Note:rÔ  …rÕ  }rÖ  (hU hjÐ  ubah#Ustrongr×  ubh:X3    Users cannot create, update or delete
check types.rØ  …rÙ  }rÚ  (hX3    Users cannot create, update or delete
check types.hjÈ  ubeubhN)rÛ  }rÜ  (hX•  Check types for commonly encountered web protocols, such as HTTP
(``remote.http``), IMAP (``remote.imap-banner``) , SMTP
(``remote.stmp``), and DNS (``remote.dns``) are provided. Monitoring
commonly encountered infrastructure servers like MySQL
(``remote.mysql-banner``) and PostgreSQL (``remote.postgresql-banner``)
are also available. Monitoring custom server uptime can be accomplished
with the remote.tcp banner check to check for a protocol-defined banner
at the beginning of a connection. Gathering metrics from server software
to create alerts against can be accomplished using the remote.http check
type and the 'extract' attribute to define the format.hhh!h"h#hRh%}rÝ  (h']h(]h)]h*]h-]uh/K”h0hh1]rÞ  (h:XB   Check types for commonly encountered web protocols, such as HTTP
(rß  …rà  }rá  (hXB   Check types for commonly encountered web protocols, such as HTTP
(hjÛ  ubj"  )râ  }rã  (hX   ``remote.http``h%}rä  (h']h(]h)]h*]h-]uhjÛ  h1]rå  h:X   remote.httpræ  …rç  }rè  (hU hjâ  ubah#j*  ubh:X	   ), IMAP (ré  …rê  }rë  (hX	   ), IMAP (hjÛ  ubj"  )rì  }rí  (hX   ``remote.imap-banner``h%}rî  (h']h(]h)]h*]h-]uhjÛ  h1]rï  h:X   remote.imap-bannerrð  …rñ  }rò  (hU hjì  ubah#j*  ubh:X
   ) , SMTP
(ró  …rô  }rõ  (hX
   ) , SMTP
(hjÛ  ubj"  )rö  }r÷  (hX   ``remote.stmp``h%}rø  (h']h(]h)]h*]h-]uhjÛ  h1]rù  h:X   remote.stmprú  …rû  }rü  (hU hjö  ubah#j*  ubh:X   ), and DNS (rý  …rþ  }rÿ  (hX   ), and DNS (hjÛ  ubj"  )r   }r  (hX   ``remote.dns``h%}r  (h']h(]h)]h*]h-]uhjÛ  h1]r  h:X
   remote.dnsr  …r  }r  (hU hj   ubah#j*  ubh:XS   ) are provided. Monitoring
commonly encountered infrastructure servers like MySQL
(r  …r  }r	  (hXS   ) are provided. Monitoring
commonly encountered infrastructure servers like MySQL
(hjÛ  ubj"  )r
  }r  (hX   ``remote.mysql-banner``h%}r  (h']h(]h)]h*]h-]uhjÛ  h1]r  h:X   remote.mysql-bannerr  …r  }r  (hU hj
  ubah#j*  ubh:X   ) and PostgreSQL (r  …r  }r  (hX   ) and PostgreSQL (hjÛ  ubj"  )r  }r  (hX   ``remote.postgresql-banner``h%}r  (h']h(]h)]h*]h-]uhjÛ  h1]r  h:X   remote.postgresql-bannerr  …r  }r  (hU hj  ubah#j*  ubh:XZ  )
are also available. Monitoring custom server uptime can be accomplished
with the remote.tcp banner check to check for a protocol-defined banner
at the beginning of a connection. Gathering metrics from server software
to create alerts against can be accomplished using the remote.http check
type and the 'extract' attribute to define the format.r  …r  }r  (hXZ  )
are also available. Monitoring custom server uptime can be accomplished
with the remote.tcp banner check to check for a protocol-defined banner
at the beginning of a connection. Gathering metrics from server software
to create alerts against can be accomplished using the remote.http check
type and the 'extract' attribute to define the format.hjÛ  ubeubhN)r  }r  (hXF  In addition to the standard Cloud Monitoring check types, you can also
use agent check types if the Monitoring Agent is installed on the server
you are monitoring. For a list of available check types, see the
`official API
documentation <http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/appendix-check-types.html>`__.hhh!h"h#hRh%}r   (h']h(]h)]h*]h-]uh/KŸh0hh1]r!  (h:XÑ   In addition to the standard Cloud Monitoring check types, you can also
use agent check types if the Monitoring Agent is installed on the server
you are monitoring. For a list of available check types, see the
r"  …r#  }r$  (hXÑ   In addition to the standard Cloud Monitoring check types, you can also
use agent check types if the Monitoring Agent is installed on the server
you are monitoring. For a list of available check types, see the
hj  ubcdocutils.nodes
reference
r%  )r&  }r'  (hXt   `official API
documentation <http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/appendix-check-types.html>`__h%}r(  (UnameX   official API documentationUrefurir)  XS   http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/appendix-check-types.htmlh*]h)]h']h(]h-]uhj  h1]r*  h:X   official API
documentationr+  …r,  }r-  (hU hj&  ubah#U	referencer.  ubh:X   .…r/  }r0  (hX   .hj  ubeubhN)r1  }r2  (hXA  Checks generate metrics that alarms will alert based upon. The metrics
generated often times depend on the check's parameters. For example,
using the 'extract' attribute on the remote.http check, however the
default metrics will always be present. To determine the exact metrics
available, the Test Check API is provided.r3  hhh!h"h#hRh%}r4  (h']h(]h)]h*]h-]uh/K¥h0hh1]r5  h:XA  Checks generate metrics that alarms will alert based upon. The metrics
generated often times depend on the check's parameters. For example,
using the 'extract' attribute on the remote.http check, however the
default metrics will always be present. To determine the exact metrics
available, the Test Check API is provided.r6  …r7  }r8  (hj3  hj1  ubaubeubh!h"h#Usystem_messager9  h%}r:  (h']UlevelKh*]h)]r;  j¾  aUsourceh"h(]h-]UlineKUtypeUINFOr<  uh/Kh0hh1]r=  hN)r>  }r?  (hU h%}r@  (h']h(]h)]h*]h-]uhhh1]rA  h:X'   Duplicate implicit target name: "info".rB  …rC  }rD  (hU hj>  ubah#hRubaubh)rE  }rF  (hU hh>h!h"h#j9  h%}rG  (h']UlevelKh*]h)]rH  hDaUsourceh"h(]h-]UlineK¬Utypej<  uh/K¬h0hh1]rI  hN)rJ  }rK  (hU h%}rL  (h']h(]h)]h*]h-]uhjE  h1]rM  h:X(   Duplicate implicit target name: "setup".rN  …rO  }rP  (hU hjJ  ubah#hRubaubh)rQ  }rR  (hU hh…h!h"h#j9  h%}rS  (h']UlevelKh*]h)]rT  h‹aUsourceh"h(]h-]UlineK½Utypej<  uh/K½h0hh1]rU  hN)rV  }rW  (hU h%}rX  (h']h(]h)]h*]h-]uhjQ  h1]rY  h:X-   Duplicate implicit target name: "attributes".rZ  …r[  }r\  (hU hjV  ubah#hRubaubeUcurrent_sourcer]  NU
decorationr^  NUautofootnote_startr_  KUnameidsr`  }ra  (hNhj   hUupdate-and-delete-checkrb  h	h,h
NhUcreate-a-checkrc  hUtest-existing-checkrd  hUlist-checksre  hNhU!attributes-used-for-remote-checksrf  hUchecksrg  hUtest-parameters-before-createrh  uh1]ri  (h)rj  }rk  (hU hhh!h"h#h$h%}rl  (h']h(]h)]h*]rm  jg  ah-]rn  hauh/Kh0hh1]ro  (h3)rp  }rq  (hX   Checksrr  hjj  h!h"h#h7h%}rs  (h']h(]h)]h*]h-]uh/Kh0hh1]rt  h:X   Checksru  …rv  }rw  (hjr  hjp  ubaubh)rx  }ry  (hU hKhjj  h!h"h#h$h%}rz  (h']r{  j¼  ah(]h)]h*]r|  Uinfor}  ah-]uh/Kh0hh1]r~  (h3)r  }r€  (hX   Infor  hjx  h!h"h#h7h%}r‚  (h']h(]h)]h*]h-]uh/Kh0hh1]rƒ  h:X   Infor„  …r…  }r†  (hj  hj  ubaubhN)r‡  }rˆ  (hXT  A check is one of the foundational building blocks of the monitoring
system. The check determines the parts or pieces of the entity that you
want to monitor, the monitoring frequency, how many monitoring zones are
originating the check, and so on. When you create a new check in the
monitoring system, you specify the following information:r‰  hjx  h!h"h#hRh%}rŠ  (h']h(]h)]h*]h-]uh/Kh0hh1]r‹  h:XT  A check is one of the foundational building blocks of the monitoring
system. The check determines the parts or pieces of the entity that you
want to monitor, the monitoring frequency, how many monitoring zones are
originating the check, and so on. When you create a new check in the
monitoring system, you specify the following information:rŒ  …r  }rŽ  (hj‰  hj‡  ubaubcdocutils.nodes
bullet_list
r  )r  }r‘  (hU hjx  h!h"h#Ubullet_listr’  h%}r“  (Ubulletr”  X   -h*]h)]h']h(]h-]uh/Kh0hh1]r•  (cdocutils.nodes
list_item
r–  )r—  }r˜  (hX   A name for the checkr™  hj  h!h"h#U	list_itemrš  h%}r›  (h']h(]h)]h*]h-]uh/Nh0hh1]rœ  hN)r  }rž  (hj™  hj—  h!h"h#hRh%}rŸ  (h']h(]h)]h*]h-]uh/Kh1]r   h:X   A name for the checkr¡  …r¢  }r£  (hj™  hj  ubaubaubj–  )r¤  }r¥  (hX   The check's parent entityr¦  hj  h!h"h#jš  h%}r§  (h']h(]h)]h*]h-]uh/Nh0hh1]r¨  hN)r©  }rª  (hj¦  hj¤  h!h"h#hRh%}r«  (h']h(]h)]h*]h-]uh/Kh1]r¬  h:X   The check's parent entityr­  …r®  }r¯  (hj¦  hj©  ubaubaubj–  )r°  }r±  (hX!   The type of check you're creatingr²  hj  h!h"h#jš  h%}r³  (h']h(]h)]h*]h-]uh/Nh0hh1]r´  hN)rµ  }r¶  (hj²  hj°  h!h"h#hRh%}r·  (h']h(]h)]h*]h-]uh/Kh1]r¸  h:X!   The type of check you're creatingr¹  …rº  }r»  (hj²  hjµ  ubaubaubj–  )r¼  }r½  (hX   Details of the checkr¾  hj  h!h"h#jš  h%}r¿  (h']h(]h)]h*]h-]uh/Nh0hh1]rÀ  hN)rÁ  }rÂ  (hj¾  hj¼  h!h"h#hRh%}rÃ  (h']h(]h)]h*]h-]uh/Kh1]rÄ  h:X   Details of the checkrÅ  …rÆ  }rÇ  (hj¾  hjÁ  ubaubaubj–  )rÈ  }rÉ  (hX0   The monitoring zones that will launch the check
hj  h!h"h#jš  h%}rÊ  (h']h(]h)]h*]h-]uh/Nh0hh1]rË  hN)rÌ  }rÍ  (hX/   The monitoring zones that will launch the checkrÎ  hjÈ  h!h"h#hRh%}rÏ  (h']h(]h)]h*]h-]uh/Kh1]rÐ  h:X/   The monitoring zones that will launch the checkrÑ  …rÒ  }rÓ  (hjÎ  hjÌ  ubaubaubeubhN)rÔ  }rÕ  (hXu  The check, as created, will not trigger alert messages until you create
an alarm to generate notifications, to enable the creation of a single
alarm that acts upon multiple checks (e.g. alert if any of ten different
servers stops responding) or multiple alarms off of a single check.
(e.g. ensure both that a HTTPS server is responding and that it has a
valid certificate).rÖ  hjx  h!h"h#hRh%}r×  (h']h(]h)]h*]h-]uh/Kh0hh1]rØ  h:Xu  The check, as created, will not trigger alert messages until you create
an alarm to generate notifications, to enable the creation of a single
alarm that acts upon multiple checks (e.g. alert if any of ten different
servers stops responding) or multiple alarms off of a single check.
(e.g. ensure both that a HTTPS server is responding and that it has a
valid certificate).rÙ  …rÚ  }rÛ  (hjÖ  hjÔ  ubaubeubh)rÜ  }rÝ  (hU hKhjj  h!h"h#h$h%}rÞ  (h']rß  hBah(]h)]h*]rà  Usetuprá  ah-]uh/Kh0hh1]râ  (h3)rã  }rä  (hX   Setuprå  hjÜ  h!h"h#h7h%}ræ  (h']h(]h)]h*]h-]uh/Kh0hh1]rç  h:X   Setuprè  …ré  }rê  (hjå  hjã  ubaubhN)rë  }rì  (hX%   Checks are sub-resources of Entities:rí  hjÜ  h!h"h#hRh%}rî  (h']h(]h)]h*]h-]uh/Kh0hh1]rï  h:X%   Checks are sub-resources of Entities:rð  …rñ  }rò  (hjí  hjë  ubaubhX)ró  }rô  (hX:   $checkId = 'chAAAA';
$check = $entity->getCheck($checkId);hjÜ  h!h"h#h[h%}rõ  (h]h^h*]h)]h']h(]rö  (h`X   phpr÷  eh-]uh/K#h0hh1]rø  hc)rù  }rú  (hX:   $checkId = 'chAAAA';
$check = $entity->getCheck($checkId);h%}rû  (h']h(]rü  Uotherrý  ah)]h*]h-]uhjó  h1]rþ  h:X:   $checkId = 'chAAAA';
$check = $entity->getCheck($checkId);rÿ  …r   }r  (hU hjù  ubah#hmubaubeubh)r  }r  (hU hKhjj  h!h"h#h$h%}r  (h']r  h‰ah(]h)]h*]r  U
attributesr  ah-]uh/K%h0hh1]r  (h3)r	  }r
  (hX
   Attributesr  hj  h!h"h#h7h%}r  (h']h(]h)]h*]h-]uh/K%h0hh1]r  h:X
   Attributesr  …r  }r  (hj  hj	  ubaubh•)r  }r  (hU hj  h!h"h#h˜h%}r  (h']h(]h)]h*]h-]uh/Nh0hh1]r  h›)r  }r  (hU h%}r  (h*]h)]h']h(]h-]UcolsKuhj  h1]r  (h )r  }r  (hU h%}r  (h*]h)]h']h(]h-]UcolwidthKuhj  h1]h#h¤ubh )r  }r  (hU h%}r  (h*]h)]h']h(]h-]UcolwidthKmuhj  h1]h#h¤ubh )r  }r   (hU h%}r!  (h*]h)]h']h(]h-]UcolwidthKuhj  h1]h#h¤ubh )r"  }r#  (hU h%}r$  (h*]h)]h']h(]h-]UcolwidthK*uhj  h1]h#h¤ubh®)r%  }r&  (hU h%}r'  (h']h(]h)]h*]h-]uhj  h1]r(  h³)r)  }r*  (hU h%}r+  (h']h(]h)]h*]h-]uhj%  h1]r,  (h¸)r-  }r.  (hU h%}r/  (h']h(]h)]h*]h-]uhj)  h1]r0  hN)r1  }r2  (hX   Namer3  hj-  h!h"h#hRh%}r4  (h']h(]h)]h*]h-]uh/K(h1]r5  h:X   Namer6  …r7  }r8  (hj3  hj1  ubaubah#hÅubh¸)r9  }r:  (hU h%}r;  (h']h(]h)]h*]h-]uhj)  h1]r<  hN)r=  }r>  (hX   Descriptionr?  hj9  h!h"h#hRh%}r@  (h']h(]h)]h*]h-]uh/K(h1]rA  h:X   DescriptionrB  …rC  }rD  (hj?  hj=  ubaubah#hÅubh¸)rE  }rF  (hU h%}rG  (h']h(]h)]h*]h-]uhj)  h1]rH  hN)rI  }rJ  (hX	   Required?rK  hjE  h!h"h#hRh%}rL  (h']h(]h)]h*]h-]uh/K(h1]rM  h:X	   Required?rN  …rO  }rP  (hjK  hjI  ubaubah#hÅubh¸)rQ  }rR  (hU h%}rS  (h']h(]h)]h*]h-]uhj)  h1]rT  hN)rU  }rV  (hX	   Data typerW  hjQ  h!h"h#hRh%}rX  (h']h(]h)]h*]h-]uh/K(h1]rY  h:X	   Data typerZ  …r[  }r\  (hjW  hjU  ubaubah#hÅubeh#hêubah#hëubhì)r]  }r^  (hU h%}r_  (h']h(]h)]h*]h-]uhj  h1]r`  (h³)ra  }rb  (hU h%}rc  (h']h(]h)]h*]h-]uhj]  h1]rd  (h¸)re  }rf  (hU h%}rg  (h']h(]h)]h*]h-]uhja  h1]rh  hN)ri  }rj  (hX   typerk  hje  h!h"h#hRh%}rl  (h']h(]h)]h*]h-]uh/K*h1]rm  h:X   typern  …ro  }rp  (hjk  hji  ubaubah#hÅubh¸)rq  }rr  (hU h%}rs  (h']h(]h)]h*]h-]uhja  h1]rt  hN)ru  }rv  (hX   The type of check.rw  hjq  h!h"h#hRh%}rx  (h']h(]h)]h*]h-]uh/K*h1]ry  h:X   The type of check.rz  …r{  }r|  (hjw  hju  ubaubah#hÅubh¸)r}  }r~  (hU h%}r  (h']h(]h)]h*]h-]uhja  h1]r€  hN)r  }r‚  (hX   Requiredrƒ  hj}  h!h"h#hRh%}r„  (h']h(]h)]h*]h-]uh/K*h1]r…  h:X   Requiredr†  …r‡  }rˆ  (hjƒ  hj  ubaubah#hÅubh¸)r‰  }rŠ  (hU h%}r‹  (h']h(]h)]h*]h-]uhja  h1]rŒ  hN)r  }rŽ  (hX&   Valid check type. String (1..25 chars)r  hj‰  h!h"h#hRh%}r  (h']h(]h)]h*]h-]uh/K*h1]r‘  h:X&   Valid check type. String (1..25 chars)r’  …r“  }r”  (hj  hj  ubaubah#hÅubeh#hêubh³)r•  }r–  (hU h%}r—  (h']h(]h)]h*]h-]uhj]  h1]r˜  (h¸)r™  }rš  (hU h%}r›  (h']h(]h)]h*]h-]uhj•  h1]rœ  hN)r  }rž  (hX   detailsrŸ  hj™  h!h"h#hRh%}r   (h']h(]h)]h*]h-]uh/K,h1]r¡  h:X   detailsr¢  …r£  }r¤  (hjŸ  hj  ubaubah#hÅubh¸)r¥  }r¦  (hU h%}r§  (h']h(]h)]h*]h-]uhj•  h1]r¨  hN)r©  }rª  (hX#   Details specific to the check type.r«  hj¥  h!h"h#hRh%}r¬  (h']h(]h)]h*]h-]uh/K,h1]r­  h:X#   Details specific to the check type.r®  …r¯  }r°  (hj«  hj©  ubaubah#hÅubh¸)r±  }r²  (hU h%}r³  (h']h(]h)]h*]h-]uhj•  h1]r´  hN)rµ  }r¶  (hX   Optionalr·  hj±  h!h"h#hRh%}r¸  (h']h(]h)]h*]h-]uh/K,h1]r¹  h:X   Optionalrº  …r»  }r¼  (hj·  hjµ  ubaubah#hÅubh¸)r½  }r¾  (hU h%}r¿  (h']h(]h)]h*]h-]uhj•  h1]rÀ  hN)rÁ  }rÂ  (hX   ArrayrÃ  hj½  h!h"h#hRh%}rÄ  (h']h(]h)]h*]h-]uh/K,h1]rÅ  h:X   ArrayrÆ  …rÇ  }rÈ  (hjÃ  hjÁ  ubaubah#hÅubeh#hêubh³)rÉ  }rÊ  (hU h%}rË  (h']h(]h)]h*]h-]uhj]  h1]rÌ  (h¸)rÍ  }rÎ  (hU h%}rÏ  (h']h(]h)]h*]h-]uhjÉ  h1]rÐ  hN)rÑ  }rÒ  (hX   disabledrÓ  hjÍ  h!h"h#hRh%}rÔ  (h']h(]h)]h*]h-]uh/K.h1]rÕ  h:X   disabledrÖ  …r×  }rØ  (hjÓ  hjÑ  ubaubah#hÅubh¸)rÙ  }rÚ  (hU h%}rÛ  (h']h(]h)]h*]h-]uhjÉ  h1]rÜ  hN)rÝ  }rÞ  (hX   Disables the check.rß  hjÙ  h!h"h#hRh%}rà  (h']h(]h)]h*]h-]uh/K.h1]rá  h:X   Disables the check.râ  …rã  }rä  (hjß  hjÝ  ubaubah#hÅubh¸)rå  }ræ  (hU h%}rç  (h']h(]h)]h*]h-]uhjÉ  h1]rè  hN)ré  }rê  (hX   Optionalrë  hjå  h!h"h#hRh%}rì  (h']h(]h)]h*]h-]uh/K.h1]rí  h:X   Optionalrî  …rï  }rð  (hjë  hjé  ubaubah#hÅubh¸)rñ  }rò  (hU h%}ró  (h']h(]h)]h*]h-]uhjÉ  h1]rô  hN)rõ  }rö  (hX   Booleanr÷  hjñ  h!h"h#hRh%}rø  (h']h(]h)]h*]h-]uh/K.h1]rù  h:X   Booleanrú  …rû  }rü  (hj÷  hjõ  ubaubah#hÅubeh#hêubh³)rý  }rþ  (hU h%}rÿ  (h']h(]h)]h*]h-]uhj]  h1]r   (h¸)r  }r  (hU h%}r  (h']h(]h)]h*]h-]uhjý  h1]r  hN)r  }r  (hX   labelr  hj  h!h"h#hRh%}r  (h']h(]h)]h*]h-]uh/K0h1]r	  h:X   labelr
  …r  }r  (hj  hj  ubaubah#hÅubh¸)r  }r  (hU h%}r  (h']h(]h)]h*]h-]uhjý  h1]r  hN)r  }r  (hX   A friendly label for a check.r  hj  h!h"h#hRh%}r  (h']h(]h)]h*]h-]uh/K0h1]r  h:X   A friendly label for a check.r  …r  }r  (hj  hj  ubaubah#hÅubh¸)r  }r  (hU h%}r  (h']h(]h)]h*]h-]uhjý  h1]r  hN)r  }r  (hX   Optionalr  hj  h!h"h#hRh%}r   (h']h(]h)]h*]h-]uh/K0h1]r!  h:X   Optionalr"  …r#  }r$  (hj  hj  ubaubah#hÅubh¸)r%  }r&  (hU h%}r'  (h']h(]h)]h*]h-]uhjý  h1]r(  hN)r)  }r*  (hX   String (1..255 chars)r+  hj%  h!h"h#hRh%}r,  (h']h(]h)]h*]h-]uh/K0h1]r-  h:X   String (1..255 chars)r.  …r/  }r0  (hj+  hj)  ubaubah#hÅubeh#hêubh³)r1  }r2  (hU h%}r3  (h']h(]h)]h*]h-]uhj]  h1]r4  (h¸)r5  }r6  (hU h%}r7  (h']h(]h)]h*]h-]uhj1  h1]r8  hN)r9  }r:  (hX   metadatar;  hj5  h!h"h#hRh%}r<  (h']h(]h)]h*]h-]uh/K2h1]r=  h:X   metadatar>  …r?  }r@  (hj;  hj9  ubaubah#hÅubh¸)rA  }rB  (hU h%}rC  (h']h(]h)]h*]h-]uhj1  h1]rD  hN)rE  }rF  (hX   Arbitrary key/value pairs.rG  hjA  h!h"h#hRh%}rH  (h']h(]h)]h*]h-]uh/K2h1]rI  h:X   Arbitrary key/value pairs.rJ  …rK  }rL  (hjG  hjE  ubaubah#hÅubh¸)rM  }rN  (hU h%}rO  (h']h(]h)]h*]h-]uhj1  h1]rP  hN)rQ  }rR  (hX   OptionalrS  hjM  h!h"h#hRh%}rT  (h']h(]h)]h*]h-]uh/K2h1]rU  h:X   OptionalrV  …rW  }rX  (hjS  hjQ  ubaubah#hÅubh¸)rY  }rZ  (hU h%}r[  (h']h(]h)]h*]h-]uhj1  h1]r\  hN)r]  }r^  (hX   Arrayr_  hjY  h!h"h#hRh%}r`  (h']h(]h)]h*]h-]uh/K2h1]ra  h:X   Arrayrb  …rc  }rd  (hj_  hj]  ubaubah#hÅubeh#hêubh³)re  }rf  (hU h%}rg  (h']h(]h)]h*]h-]uhj]  h1]rh  (h¸)ri  }rj  (hU h%}rk  (h']h(]h)]h*]h-]uhje  h1]rl  hN)rm  }rn  (hX   periodro  hji  h!h"h#hRh%}rp  (h']h(]h)]h*]h-]uh/K4h1]rq  h:X   periodrr  …rs  }rt  (hjo  hjm  ubaubah#hÅubh¸)ru  }rv  (hU h%}rw  (h']h(]h)]h*]h-]uhje  h1]rx  hN)ry  }rz  (hXi   The period in seconds for a check. The value must be greater than the minimum period set on your account.r{  hju  h!h"h#hRh%}r|  (h']h(]h)]h*]h-]uh/K4h1]r}  h:Xi   The period in seconds for a check. The value must be greater than the minimum period set on your account.r~  …r  }r€  (hj{  hjy  ubaubah#hÅubh¸)r  }r‚  (hU h%}rƒ  (h']h(]h)]h*]h-]uhje  h1]r„  hN)r…  }r†  (hX   Optionalr‡  hj  h!h"h#hRh%}rˆ  (h']h(]h)]h*]h-]uh/K4h1]r‰  h:X   OptionalrŠ  …r‹  }rŒ  (hj‡  hj…  ubaubah#hÅubh¸)r  }rŽ  (hU h%}r  (h']h(]h)]h*]h-]uhje  h1]r  hN)r‘  }r’  (hX   Integer (30..1800)r“  hj  h!h"h#hRh%}r”  (h']h(]h)]h*]h-]uh/K4h1]r•  h:X   Integer (30..1800)r–  …r—  }r˜  (hj“  hj‘  ubaubah#hÅubeh#hêubh³)r™  }rš  (hU h%}r›  (h']h(]h)]h*]h-]uhj]  h1]rœ  (h¸)r  }rž  (hU h%}rŸ  (h']h(]h)]h*]h-]uhj™  h1]r   hN)r¡  }r¢  (hX   timeoutr£  hj  h!h"h#hRh%}r¤  (h']h(]h)]h*]h-]uh/K6h1]r¥  h:X   timeoutr¦  …r§  }r¨  (hj£  hj¡  ubaubah#hÅubh¸)r©  }rª  (hU h%}r«  (h']h(]h)]h*]h-]uhj™  h1]r¬  hN)r­  }r®  (hXH   The timeout in seconds for a check. This has to be less than the period.r¯  hj©  h!h"h#hRh%}r°  (h']h(]h)]h*]h-]uh/K6h1]r±  h:XH   The timeout in seconds for a check. This has to be less than the period.r²  …r³  }r´  (hj¯  hj­  ubaubah#hÅubh¸)rµ  }r¶  (hU h%}r·  (h']h(]h)]h*]h-]uhj™  h1]r¸  hN)r¹  }rº  (hX   Optionalr»  hjµ  h!h"h#hRh%}r¼  (h']h(]h)]h*]h-]uh/K6h1]r½  h:X   Optionalr¾  …r¿  }rÀ  (hj»  hj¹  ubaubah#hÅubh¸)rÁ  }rÂ  (hU h%}rÃ  (h']h(]h)]h*]h-]uhj™  h1]rÄ  hN)rÅ  }rÆ  (hX   Integer (2..1800)rÇ  hjÁ  h!h"h#hRh%}rÈ  (h']h(]h)]h*]h-]uh/K6h1]rÉ  h:X   Integer (2..1800)rÊ  …rË  }rÌ  (hjÇ  hjÅ  ubaubah#hÅubeh#hêubeh#jš  ubeh#j›  ubaubh)rÍ  }rÎ  (hU hj  h!h"h#h$h%}rÏ  (h']h(]h)]h*]rÐ  jf  ah-]rÑ  hauh/K:h0hh1]rÒ  (h3)rÓ  }rÔ  (hX!   Attributes used for remote ChecksrÕ  hjÍ  h!h"h#h7h%}rÖ  (h']h(]h)]h*]h-]uh/K:h0hh1]r×  h:X!   Attributes used for remote ChecksrØ  …rÙ  }rÚ  (hjÕ  hjÓ  ubaubh•)rÛ  }rÜ  (hU hjÍ  h!h"h#h˜h%}rÝ  (h']h(]h)]h*]h-]uh/Nh0hh1]rÞ  h›)rß  }rà  (hU h%}rá  (h*]h)]h']h(]h-]UcolsKuhjÛ  h1]râ  (h )rã  }rä  (hU h%}rå  (h*]h)]h']h(]h-]UcolwidthKuhjß  h1]h#h¤ubh )ræ  }rç  (hU h%}rè  (h*]h)]h']h(]h-]UcolwidthK˜uhjß  h1]h#h¤ubh )ré  }rê  (hU h%}rë  (h*]h)]h']h(]h-]UcolwidthKuhjß  h1]h#h¤ubh )rì  }rí  (hU h%}rî  (h*]h)]h']h(]h-]UcolwidthK<uhjß  h1]h#h¤ubh®)rï  }rð  (hU h%}rñ  (h']h(]h)]h*]h-]uhjß  h1]rò  h³)ró  }rô  (hU h%}rõ  (h']h(]h)]h*]h-]uhjï  h1]rö  (h¸)r÷  }rø  (hU h%}rù  (h']h(]h)]h*]h-]uhjó  h1]rú  hN)rû  }rü  (hX   Namerý  hj÷  h!h"h#hRh%}rþ  (h']h(]h)]h*]h-]uh/K=h1]rÿ  h:X   Namer   …r  }r  (hjý  hjû  ubaubah#hÅubh¸)r  }r  (hU h%}r  (h']h(]h)]h*]h-]uhjó  h1]r  hN)r  }r  (hX   Descriptionr	  hj  h!h"h#hRh%}r
  (h']h(]h)]h*]h-]uh/K=h1]r  h:X   Descriptionr  …r  }r  (hj	  hj  ubaubah#hÅubh¸)r  }r  (hU h%}r  (h']h(]h)]h*]h-]uhjó  h1]r  hN)r  }r  (hX	   Required?r  hj  h!h"h#hRh%}r  (h']h(]h)]h*]h-]uh/K=h1]r  h:X	   Required?r  …r  }r  (hj  hj  ubaubah#hÅubh¸)r  }r  (hU h%}r  (h']h(]h)]h*]h-]uhjó  h1]r  hN)r  }r   (hX	   Data typer!  hj  h!h"h#hRh%}r"  (h']h(]h)]h*]h-]uh/K=h1]r#  h:X	   Data typer$  …r%  }r&  (hj!  hj  ubaubah#hÅubeh#hêubah#hëubhì)r'  }r(  (hU h%}r)  (h']h(]h)]h*]h-]uhjß  h1]r*  (h³)r+  }r,  (hU h%}r-  (h']h(]h)]h*]h-]uhj'  h1]r.  (h¸)r/  }r0  (hU h%}r1  (h']h(]h)]h*]h-]uhj+  h1]r2  hN)r3  }r4  (hX   monitoring\_zones\_pollhj/  h!h"h#hRh%}r5  (h']h(]h)]h*]h-]uh/K?h1]r6  h:X   monitoring_zones_pollr7  …r8  }r9  (hX   monitoring\_zones\_pollhj3  ubaubah#hÅubh¸)r:  }r;  (hU h%}r<  (h']h(]h)]h*]h-]uhj+  h1]r=  hN)r>  }r?  (hXi   List of monitoring zones to poll from. Note: This argument is only required for remote (non-agent) checksr@  hj:  h!h"h#hRh%}rA  (h']h(]h)]h*]h-]uh/K?h1]rB  h:Xi   List of monitoring zones to poll from. Note: This argument is only required for remote (non-agent) checksrC  …rD  }rE  (hj@  hj>  ubaubah#hÅubh¸)rF  }rG  (hU h%}rH  (h']h(]h)]h*]h-]uhj+  h1]rI  hN)rJ  }rK  (hX   OptionalrL  hjF  h!h"h#hRh%}rM  (h']h(]h)]h*]h-]uh/K?h1]rN  h:X   OptionalrO  …rP  }rQ  (hjL  hjJ  ubaubah#hÅubh¸)rR  }rS  (hU h%}rT  (h']h(]h)]h*]h-]uhj+  h1]rU  hN)rV  }rW  (hX   ArrayrX  hjR  h!h"h#hRh%}rY  (h']h(]h)]h*]h-]uh/K?h1]rZ  h:X   Arrayr[  …r\  }r]  (hjX  hjV  ubaubah#hÅubeh#hêubh³)r^  }r_  (hU h%}r`  (h']h(]h)]h*]h-]uhj'  h1]ra  (h¸)rb  }rc  (hU h%}rd  (h']h(]h)]h*]h-]uhj^  h1]re  hN)rf  }rg  (hX   target\_aliashjb  h!h"h#hRh%}rh  (h']h(]h)]h*]h-]uh/KAh1]ri  h:X   target_aliasrj  …rk  }rl  (hX   target\_aliashjf  ubaubah#hÅubh¸)rm  }rn  (hU h%}ro  (h']h(]h)]h*]h-]uhj^  h1]rp  hN)rq  }rr  (hX”   A key in the entity's ``ip_addresses`` hash used to resolve this check to an IP address. This parameter is mutually exclusive with target\_hostname.hjm  h!h"h#hRh%}rs  (h']h(]h)]h*]h-]uh/KAh1]rt  (h:X   A key in the entity's ru  …rv  }rw  (hX   A key in the entity's hjq  ubj"  )rx  }ry  (hX   ``ip_addresses``h%}rz  (h']h(]h)]h*]h-]uhjq  h1]r{  h:X   ip_addressesr|  …r}  }r~  (hU hjx  ubah#j*  ubh:Xm    hash used to resolve this check to an IP address. This parameter is mutually exclusive with target_hostname.r  …r€  }r  (hXn    hash used to resolve this check to an IP address. This parameter is mutually exclusive with target\_hostname.hjq  ubeubah#hÅubh¸)r‚  }rƒ  (hU h%}r„  (h']h(]h)]h*]h-]uhj^  h1]r…  hN)r†  }r‡  (hX   Optionalrˆ  hj‚  h!h"h#hRh%}r‰  (h']h(]h)]h*]h-]uh/KAh1]rŠ  h:X   Optionalr‹  …rŒ  }r  (hjˆ  hj†  ubaubah#hÅubh¸)rŽ  }r  (hU h%}r  (h']h(]h)]h*]h-]uhj^  h1]r‘  hN)r’  }r“  (hX   String (1..64 chars)r”  hjŽ  h!h"h#hRh%}r•  (h']h(]h)]h*]h-]uh/KAh1]r–  h:X   String (1..64 chars)r—  …r˜  }r™  (hj”  hj’  ubaubah#hÅubeh#hêubh³)rš  }r›  (hU h%}rœ  (h']h(]h)]h*]h-]uhj'  h1]r  (h¸)rž  }rŸ  (hU h%}r   (h']h(]h)]h*]h-]uhjš  h1]r¡  hN)r¢  }r£  (hX   target\_hostnamehjž  h!h"h#hRh%}r¤  (h']h(]h)]h*]h-]uh/KCh1]r¥  h:X   target_hostnamer¦  …r§  }r¨  (hX   target\_hostnamehj¢  ubaubah#hÅubh¸)r©  }rª  (hU h%}r«  (h']h(]h)]h*]h-]uhjš  h1]r¬  hN)r­  }r®  (hXb   The hostname this check should target. This parameter is mutually exclusive with ``target_alias``.hj©  h!h"h#hRh%}r¯  (h']h(]h)]h*]h-]uh/KCh1]r°  (h:XQ   The hostname this check should target. This parameter is mutually exclusive with r±  …r²  }r³  (hXQ   The hostname this check should target. This parameter is mutually exclusive with hj­  ubj"  )r´  }rµ  (hX   ``target_alias``h%}r¶  (h']h(]h)]h*]h-]uhj­  h1]r·  h:X   target_aliasr¸  …r¹  }rº  (hU hj´  ubah#j*  ubh:X   .…r»  }r¼  (hX   .hj­  ubeubah#hÅubh¸)r½  }r¾  (hU h%}r¿  (h']h(]h)]h*]h-]uhjš  h1]rÀ  hN)rÁ  }rÂ  (hX   OptionalrÃ  hj½  h!h"h#hRh%}rÄ  (h']h(]h)]h*]h-]uh/KCh1]rÅ  h:X   OptionalrÆ  …rÇ  }rÈ  (hjÃ  hjÁ  ubaubah#hÅubh¸)rÉ  }rÊ  (hU h%}rË  (h']h(]h)]h*]h-]uhjš  h1]rÌ  hN)rÍ  }rÎ  (hX8   Valid FQDN, IPv4 or IPv6 address. String (1..256 chars).rÏ  hjÉ  h!h"h#hRh%}rÐ  (h']h(]h)]h*]h-]uh/KCh1]rÑ  h:X8   Valid FQDN, IPv4 or IPv6 address. String (1..256 chars).rÒ  …rÓ  }rÔ  (hjÏ  hjÍ  ubaubah#hÅubeh#hêubh³)rÕ  }rÖ  (hU h%}r×  (h']h(]h)]h*]h-]uhj'  h1]rØ  (h¸)rÙ  }rÚ  (hU h%}rÛ  (h']h(]h)]h*]h-]uhjÕ  h1]rÜ  hN)rÝ  }rÞ  (hX   target\_resolverhjÙ  h!h"h#hRh%}rß  (h']h(]h)]h*]h-]uh/KEh1]rà  h:X   target_resolverrá  …râ  }rã  (hX   target\_resolverhjÝ  ubaubah#hÅubh¸)rä  }rå  (hU h%}ræ  (h']h(]h)]h*]h-]uhjÕ  h1]rç  hN)rè  }ré  (hX+   Determines how to resolve the check target.rê  hjä  h!h"h#hRh%}rë  (h']h(]h)]h*]h-]uh/KEh1]rì  h:X+   Determines how to resolve the check target.rí  …rî  }rï  (hjê  hjè  ubaubah#hÅubh¸)rð  }rñ  (hU h%}rò  (h']h(]h)]h*]h-]uhjÕ  h1]ró  hN)rô  }rõ  (hX   Optionalrö  hjð  h!h"h#hRh%}r÷  (h']h(]h)]h*]h-]uh/KEh1]rø  h:X   Optionalrù  …rú  }rû  (hjö  hjô  ubaubah#hÅubh¸)rü  }rý  (hU h%}rþ  (h']h(]h)]h*]h-]uhjÕ  h1]rÿ  hN)r   }r  (hX   ``IPv4`` or ``IPv6``r  hjü  h!h"h#hRh%}r  (h']h(]h)]h*]h-]uh/KEh1]r  (j"  )r  }r  (hX   ``IPv4``h%}r  (h']h(]h)]h*]h-]uhj   h1]r  h:X   IPv4r	  …r
  }r  (hU hj  ubah#j*  ubh:X    or r  …r  }r  (hX    or hj   ubj"  )r  }r  (hX   ``IPv6``h%}r  (h']h(]h)]h*]h-]uhj   h1]r  h:X   IPv6r  …r  }r  (hU hj  ubah#j*  ubeubah#hÅubeh#hêubeh#jš  ubeh#j›  ubaubeubeubh)r  }r  (hU hjj  h!h"h#h$h%}r  (h']h(]h)]h*]r  jh  ah-]r  hauh/KIh0hh1]r  (h3)r  }r  (hX   Test parameters (before create)r  hj  h!h"h#h7h%}r  (h']h(]h)]h*]h-]uh/KIh0hh1]r   h:X   Test parameters (before create)r!  …r"  }r#  (hj  hj  ubaubhX)r$  }r%  (hXQ  $params = array(
    'type'   => 'remote.http',
    'details' => array(
        'url'    => 'http://example.com',
        'method' => 'GET'
    ),
    'monitoring_zones_poll' => array('mzlon'),
    'period' => '100',
    'timeout' => '30',
    'target_alias' => 'default',
    'label'  => 'Website check 1'
);

// You can do a test to see what would happen
// if a Check is launched with these params
$response = $entity->testNewCheckParams($params);

echo $response->timestamp; // When was it executed?
echo $response->available; // Was it available?
echo $response->status;    // Status codehj  h!h"h#h[h%}r&  (h]h^h*]h)]h']h(]r'  (h`X   phpr(  eh-]uh/Kah0hh1]r)  hc)r*  }r+  (hXQ  $params = array(
    'type'   => 'remote.http',
    'details' => array(
        'url'    => 'http://example.com',
        'method' => 'GET'
    ),
    'monitoring_zones_poll' => array('mzlon'),
    'period' => '100',
    'timeout' => '30',
    'target_alias' => 'default',
    'label'  => 'Website check 1'
);

// You can do a test to see what would happen
// if a Check is launched with these params
$response = $entity->testNewCheckParams($params);

echo $response->timestamp; // When was it executed?
echo $response->available; // Was it available?
echo $response->status;    // Status codeh%}r,  (h']h(]r-  Uotherr.  ah)]h*]h-]uhj$  h1]r/  h:XQ  $params = array(
    'type'   => 'remote.http',
    'details' => array(
        'url'    => 'http://example.com',
        'method' => 'GET'
    ),
    'monitoring_zones_poll' => array('mzlon'),
    'period' => '100',
    'timeout' => '30',
    'target_alias' => 'default',
    'label'  => 'Website check 1'
);

// You can do a test to see what would happen
// if a Check is launched with these params
$response = $entity->testNewCheckParams($params);

echo $response->timestamp; // When was it executed?
echo $response->available; // Was it available?
echo $response->status;    // Status coder0  …r1  }r2  (hU hj*  ubah#hmubaubeubh)r3  }r4  (hU hjj  h!h"h#h$h%}r5  (h']h(]h)]h*]r6  jc  ah-]r7  hauh/Kch0hh1]r8  (h3)r9  }r:  (hX   Create a Checkr;  hj3  h!h"h#h7h%}r<  (h']h(]h)]h*]h-]uh/Kch0hh1]r=  h:X   Create a Checkr>  …r?  }r@  (hj;  hj9  ubaubhX)rA  }rB  (hX   $entity->createCheck($params);hj3  h!h"h#h[h%}rC  (h]h^h*]h)]h']h(]rD  (h`X   phprE  eh-]uh/Khh0hh1]rF  hc)rG  }rH  (hX   $entity->createCheck($params);h%}rI  (h']h(]rJ  UotherrK  ah)]h*]h-]uhjA  h1]rL  h:X   $entity->createCheck($params);rM  …rN  }rO  (hU hjG  ubah#hmubaubeubh)rP  }rQ  (hU hjj  h!h"h#h$h%}rR  (h']h(]h)]h*]rS  jd  ah-]rT  hauh/Kjh0hh1]rU  (h3)rV  }rW  (hX   Test existing CheckrX  hjP  h!h"h#h7h%}rY  (h']h(]h)]h*]h-]uh/Kjh0hh1]rZ  h:X   Test existing Checkr[  …r\  }r]  (hjX  hjV  ubaubhX)r^  }r_  (hXe   // Set arg to TRUE for debug information
$response = $check->test(true);

echo $response->debug_info;hjP  h!h"h#h[h%}r`  (h]h^h*]h)]h']h(]ra  (h`X   phprb  eh-]uh/Krh0hh1]rc  hc)rd  }re  (hXe   // Set arg to TRUE for debug information
$response = $check->test(true);

echo $response->debug_info;h%}rf  (h']h(]rg  Uotherrh  ah)]h*]h-]uhj^  h1]ri  h:Xe   // Set arg to TRUE for debug information
$response = $check->test(true);

echo $response->debug_info;rj  …rk  }rl  (hU hjd  ubah#hmubaubeubh)rm  }rn  (hU hjj  h!h"h#h$h%}ro  (h']h(]h)]h*]rp  je  ah-]rq  hauh/Kth0hh1]rr  (h3)rs  }rt  (hX   List Checksru  hjm  h!h"h#h7h%}rv  (h']h(]h)]h*]h-]uh/Kth0hh1]rw  h:X   List Checksrx  …ry  }rz  (hju  hjs  ubaubhX)r{  }r|  (hXZ   $checks = $entity->getChecks();

foreach ($checks as $check) {
    echo $check->getId();
}hjm  h!h"h#h[h%}r}  (h]h^h*]h)]h']h(]r~  (h`X   phpr  eh-]uh/K}h0hh1]r€  hc)r  }r‚  (hXZ   $checks = $entity->getChecks();

foreach ($checks as $check) {
    echo $check->getId();
}h%}rƒ  (h']h(]r„  Uotherr…  ah)]h*]h-]uhj{  h1]r†  h:XZ   $checks = $entity->getChecks();

foreach ($checks as $check) {
    echo $check->getId();
}r‡  …rˆ  }r‰  (hU hj  ubah#hmubaubh)rŠ  }r‹  (hU hjm  h!h"h#h$h%}rŒ  (h']h(]h)]h*]r  jb  ah-]rŽ  hauh/Kh0hh1]r  (h3)r  }r‘  (hX   Update and delete Checkr’  hjŠ  h!h"h#h7h%}r“  (h']h(]h)]h*]h-]uh/Kh0hh1]r”  h:X   Update and delete Checkr•  …r–  }r—  (hj’  hj  ubaubhX)r˜  }r™  (hXN   // Update
$check->update(array('period' => 500));

// Delete
$check->delete();hjŠ  h!h"h#h[h%}rš  (h]h^h*]h)]h']h(]r›  (h`X   phprœ  eh-]uh/Kˆh0hh1]r  hc)rž  }rŸ  (hXN   // Update
$check->update(array('period' => 500));

// Delete
$check->delete();h%}r   (h']h(]r¡  Uotherr¢  ah)]h*]h-]uhj˜  h1]r£  h:XN   // Update
$check->update(array('period' => 500));

// Delete
$check->delete();r¤  …r¥  }r¦  (hU hjž  ubah#hmubaubeubeubeubhehU Utransformerr§  NUfootnote_refsr¨  }r©  Urefnamesrª  }r«  Usymbol_footnotesr¬  ]r­  Uautofootnote_refsr®  ]r¯  Usymbol_footnote_refsr°  ]r±  U	citationsr²  ]r³  h0hUcurrent_liner´  NUtransform_messagesrµ  ]r¶  Ureporterr·  NUid_startr¸  KUautofootnotesr¹  ]rº  Ucitation_refsr»  }r¼  Uindirect_targetsr½  ]r¾  Usettingsr¿  (cdocutils.frontend
Values
rÀ  orÁ  }rÂ  (Ufootnote_backlinksrÃ  KUrecord_dependenciesrÄ  NUrfc_base_urlrÅ  Uhttp://tools.ietf.org/html/rÆ  U	tracebackrÇ  ˆUpep_referencesrÈ  NUstrip_commentsrÉ  NUtoc_backlinksrÊ  hÅUlanguage_coderË  UenrÌ  U	datestamprÍ  NUreport_levelrÎ  KU_destinationrÏ  NU
halt_levelrÐ  KUstrip_classesrÑ  Nh7NUerror_encoding_error_handlerrÒ  UbackslashreplacerÓ  UdebugrÔ  NUembed_stylesheetrÕ  ‰Uoutput_encoding_error_handlerrÖ  Ustrictr×  Usectnum_xformrØ  KUdump_transformsrÙ  NUdocinfo_xformrÚ  KUwarning_streamrÛ  NUpep_file_url_templaterÜ  Upep-%04drÝ  Uexit_status_levelrÞ  KUconfigrß  NUstrict_visitorrà  NUcloak_email_addressesrá  ˆUtrim_footnote_reference_spacerâ  ‰Uenvrã  NUdump_pseudo_xmlrä  NUexpose_internalsrå  NUsectsubtitle_xformræ  ‰Usource_linkrç  NUrfc_referencesrè  NUoutput_encodingré  Uutf-8rê  U
source_urlrë  NUinput_encodingrì  U	utf-8-sigrí  U_disable_configrî  NU	id_prefixrï  U U	tab_widthrð  KUerror_encodingrñ  UUTF-8rò  U_sourceró  h"Ugettext_compactrô  ˆU	generatorrõ  NUdump_internalsrö  NUsmart_quotesr÷  ‰Upep_base_urlrø  Uhttp://www.python.org/dev/peps/rù  Usyntax_highlightrú  Ulongrû  Uinput_encoding_error_handlerrü  j×  Uauto_id_prefixrý  Uidrþ  Udoctitle_xformrÿ  ‰Ustrip_elements_with_classesr   NU_config_filesr  ]Ufile_insertion_enabledr  ˆUraw_enabledr  KUdump_settingsr  NubUsymbol_footnote_startr  K Uidsr  }r  (j}  jx  j   jœ  jb  jŠ  jc  j3  jh  j  já  jÜ  hDh>h‹h…h,hjd  jP  je  jm  j  j  jf  jÍ  jg  jj  j¾  huUsubstitution_namesr  }r	  h#h0h%}r
  (h']h*]h)]Usourceh"h(]h-]uU	footnotesr  ]r  Urefidsr  }r  ub.