€cdocutils.nodes
document
q)q}q(U	nametypesq}q(X   list recordsqNX
   get recordqNX   find a record id from its nameqNX   modify recordq	NX   delete recordq
NX   query parametersqNX   recordsqNX
   add recordq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 hh)q}q(hU hh)q}q(hU hhUsourceqXG   /Users/jamie/projects/php/php-opencloud/doc/services/dns/Records.md.rstqUtagnameq Usectionq!U
attributesq"}q#(Udupnamesq$]Uclassesq%]Ubackrefsq&]Uidsq']q(Urecordsq)aUnamesq*]q+hauUlineq,KUdocumentq-hUchildrenq.]q/(cdocutils.nodes
title
q0)q1}q2(hX   Recordsq3hhhhh Utitleq4h"}q5(h$]h%]h&]h']h*]uh,Kh-hh.]q6cdocutils.nodes
Text
q7X   Recordsq8…q9}q:(hh3hh1ubaubcdocutils.nodes
paragraph
q;)q<}q=(hX`   A DNS record belongs to a particular domain and is used to specify
information about the domain.q>hhhhh U	paragraphq?h"}q@(h$]h%]h&]h']h*]uh,Kh-hh.]qAh7X`   A DNS record belongs to a particular domain and is used to specify
information about the domain.qB…qC}qD(hh>hh<ubaubh;)qE}qF(hXä   There are several types of DNS records. Examples include mail exchange
(MX) records, which specify the mail server for a particular domain, and
name server (NS) records, which specify the authoritative name servers
for a domain.qGhhhhh h?h"}qH(h$]h%]h&]h']h*]uh,Kh-hh.]qIh7Xä   There are several types of DNS records. Examples include mail exchange
(MX) records, which specify the mail server for a particular domain, and
name server (NS) records, which specify the authoritative name servers
for a domain.qJ…qK}qL(hhGhhEubaubh;)qM}qN(hXn   It is represented by the ``OpenCloud\DNS\Resource\Record`` class.
Records belong to a `Domain <Domains.md>`__.hhhhh h?h"}qO(h$]h%]h&]h']h*]uh,Kh-hh.]qP(h7X   It is represented by the qQ…qR}qS(hX   It is represented by the hhMubcdocutils.nodes
literal
qT)qU}qV(hX!   ``OpenCloud\DNS\Resource\Record``h"}qW(h$]h%]h&]h']h*]uhhMh.]qXh7X   OpenCloud\DNS\Resource\RecordqY…qZ}q[(hU hhUubah Uliteralq\ubh7X    class.
Records belong to a q]…q^}q_(hX    class.
Records belong to a hhMubcdocutils.nodes
reference
q`)qa}qb(hX   `Domain <Domains.md>`__h"}qc(UnameX   DomainUrefuriqdX
   Domains.mdh']h&]h$]h%]h*]uhhMh.]qeh7X   Domainqf…qg}qh(hU hhaubah U	referenceqiubh7X   .…qj}qk(hX   .hhMubeubh)ql}qm(hU hhhhh h!h"}qn(h$]h%]h&]h']qoU
get-recordqpah*]qqhauh,Kh-hh.]qr(h0)qs}qt(hX
   Get recordquhhlhhh h4h"}qv(h$]h%]h&]h']h*]uh,Kh-hh.]qwh7X
   Get recordqx…qy}qz(hhuhhsubaubh;)q{}q|(hXQ   In order to retrieve details for a specific DNS record, you will need
its **id**:hhlhhh h?h"}q}(h$]h%]h&]h']h*]uh,Kh-hh.]q~(h7XJ   In order to retrieve details for a specific DNS record, you will need
its q…q€}q(hXJ   In order to retrieve details for a specific DNS record, you will need
its hh{ubcdocutils.nodes
strong
q‚)qƒ}q„(hX   **id**h"}q…(h$]h%]h&]h']h*]uhh{h.]q†h7X   idq‡…qˆ}q‰(hU hhƒubah UstrongqŠubh7X   :…q‹}qŒ(hX   :hh{ubeubcdocutils.nodes
literal_block
q)qŽ}q(hX(   $record = $domain->record('NS-1234567');hhlhhh Uliteral_blockqh"}q‘(U	xml:spaceq’Upreserveq“h']h&]h$]h%]q”(Ucodeq•X   phpq–eh*]uh,Kh-hh.]q—cdocutils.nodes
inline
q˜)q™}qš(hX(   $record = $domain->record('NS-1234567');h"}q›(h$]h%]qœUotherqah&]h']h*]uhhŽh.]qžh7X(   $record = $domain->record('NS-1234567');qŸ…q }q¡(hU hh™ubah Uinlineq¢ubaubh;)q£}q¤(hX€   If you do not have this ID at your disposal, you can traverse the record
collection and do a string comparison (detailed below).q¥hhlhhh h?h"}q¦(h$]h%]h&]h']h*]uh,Kh-hh.]q§h7X€   If you do not have this ID at your disposal, you can traverse the record
collection and do a string comparison (detailed below).q¨…q©}qª(hh¥hh£ubaubeubhh)q«}q¬(hU hhhhh h!h"}q­(h$]h%]h&]h']q®U
add-recordq¯ah*]q°hauh,KNh-hh.]q±(h0)q²}q³(hX
   Add recordq´hh«hhh h4h"}qµ(h$]h%]h&]h']h*]uh,KNh-hh.]q¶h7X
   Add recordq·…q¸}q¹(hh´hh²ubaubh;)qº}q»(hX4   This call adds a new record to the specified domain:q¼hh«hhh h?h"}q½(h$]h%]h&]h']h*]uh,KPh-hh.]q¾h7X4   This call adds a new record to the specified domain:q¿…qÀ}qÁ(hh¼hhºubaubh)qÂ}qÃ(hX—   $record = $domain->record(array(
    'type' => 'A',
    'name' => 'example.com',
    'data' => '192.0.2.17',
    'ttl'  => 3600
));

$record->create();hh«hhh hh"}qÄ(h’h“h']h&]h$]h%]qÅ(h•X   phpqÆeh*]uh,K\h-hh.]qÇh˜)qÈ}qÉ(hX—   $record = $domain->record(array(
    'type' => 'A',
    'name' => 'example.com',
    'data' => '192.0.2.17',
    'ttl'  => 3600
));

$record->create();h"}qÊ(h$]h%]qËUotherqÌah&]h']h*]uhhÂh.]qÍh7X—   $record = $domain->record(array(
    'type' => 'A',
    'name' => 'example.com',
    'data' => '192.0.2.17',
    'ttl'  => 3600
));

$record->create();qÎ…qÏ}qÐ(hU hhÈubah h¢ubaubh;)qÑ}qÒ(hXq   Please be aware that records that are added with a different hostname
than the parent domain might fail silently.qÓhh«hhh h?h"}qÔ(h$]h%]h&]h']h*]uh,K]h-hh.]qÕh7Xq   Please be aware that records that are added with a different hostname
than the parent domain might fail silently.qÖ…q×}qØ(hhÓhhÑubaubeubh)qÙ}qÚ(hU hhhhh h!h"}qÛ(h$]h%]h&]h']qÜUmodify-recordqÝah*]qÞh	auh,Kah-hh.]qß(h0)qà}qá(hX   Modify recordqâhhÙhhh h4h"}qã(h$]h%]h&]h']h*]uh,Kah-hh.]qäh7X   Modify recordqå…qæ}qç(hhâhhàubaubh)qè}qé(hXJ   $record = $domain->record(123456);
$record->ttl -= 100;
$record->update();hhÙhhh hh"}qê(h’h“h']h&]h$]h%]që(h•X   phpqìeh*]uh,Khh-hh.]qíh˜)qî}qï(hXJ   $record = $domain->record(123456);
$record->ttl -= 100;
$record->update();h"}qð(h$]h%]qñUotherqòah&]h']h*]uhhèh.]qóh7XJ   $record = $domain->record(123456);
$record->ttl -= 100;
$record->update();qô…qõ}qö(hU hhîubah h¢ubaubeubh)q÷}qø(hU hhhhh h!h"}qù(h$]h%]h&]h']qúUdelete-recordqûah*]qüh
auh,Kjh-hh.]qý(h0)qþ}qÿ(hX   Delete recordr   hh÷hhh h4h"}r  (h$]h%]h&]h']h*]uh,Kjh-hh.]r  h7X   Delete recordr  …r  }r  (hj   hhþubaubh)r  }r  (hX   $record->delete();hh÷hhh hh"}r  (h’h“h']h&]h$]h%]r	  (h•X   phpr
  eh*]uh,Koh-hh.]r  h˜)r  }r  (hX   $record->delete();h"}r  (h$]h%]r  Uotherr  ah&]h']h*]uhj  h.]r  h7X   $record->delete();r  …r  }r  (hU hj  ubah h¢ubaubeubeubhhh h!h"}r  (h$]h%]h&]h']r  Ulist-recordsr  ah*]r  hauh,Kh-hh.]r  (h0)r  }r  (hX   List recordsr  hhhhh h4h"}r  (h$]h%]h&]h']h*]uh,Kh-hh.]r  h7X   List recordsr  …r   }r!  (hj  hj  ubaubh;)r"  }r#  (hX@   This call lists all records configured for the specified domain.r$  hhhhh h?h"}r%  (h$]h%]h&]h']h*]uh,Kh-hh.]r&  h7X@   This call lists all records configured for the specified domain.r'  …r(  }r)  (hj$  hj"  ubaubh)r*  }r+  (hX    $records = $domain->recordList();

foreach ($records as $record) {
    printf("Record name: %s, ID: %s, TTL: %s\n", $record->name, $record->id, $record->ttl);
}hhhhh hh"}r,  (h’h“h']h&]h$]h%]r-  (h•X   phpr.  eh*]uh,K(h-hh.]r/  h˜)r0  }r1  (hX    $records = $domain->recordList();

foreach ($records as $record) {
    printf("Record name: %s, ID: %s, TTL: %s\n", $record->name, $record->id, $record->ttl);
}h"}r2  (h$]h%]r3  Uotherr4  ah&]h']h*]uhj*  h.]r5  h7X    $records = $domain->recordList();

foreach ($records as $record) {
    printf("Record name: %s, ID: %s, TTL: %s\n", $record->name, $record->id, $record->ttl);
}r6  …r7  }r8  (hU hj0  ubah h¢ubaubh;)r9  }r:  (hXq   Please consult the `iterator
documentation <docs/userguide/Iterators.md>`__ for more information
about iterators.hhhhh h?h"}r;  (h$]h%]h&]h']h*]uh,K)h-hh.]r<  (h7X   Please consult the r=  …r>  }r?  (hX   Please consult the hj9  ubh`)r@  }rA  (hX8   `iterator
documentation <docs/userguide/Iterators.md>`__h"}rB  (UnameX   iterator documentationhdX   docs/userguide/Iterators.mdh']h&]h$]h%]h*]uhj9  h.]rC  h7X   iterator
documentationrD  …rE  }rF  (hU hj@  ubah hiubh7X&    for more information
about iterators.rG  …rH  }rI  (hX&    for more information
about iterators.hj9  ubeubhh)rJ  }rK  (hU hhhhh h!h"}rL  (h$]h%]h&]h']rM  Ufind-a-record-id-from-its-namerN  ah*]rO  hauh,K>h-hh.]rP  (h0)rQ  }rR  (hX   Find a record ID from its namerS  hjJ  hhh h4h"}rT  (h$]h%]h&]h']h*]uh,K>h-hh.]rU  h7X   Find a record ID from its namerV  …rW  }rX  (hjS  hjQ  ubaubh;)rY  }rZ  (hX   For example:r[  hjJ  hhh h?h"}r\  (h$]h%]h&]h']h*]uh,K@h-hh.]r]  h7X   For example:r^  …r_  }r`  (hj[  hjY  ubaubh)ra  }rb  (hXž   $records = $domain->recordList(array(
    'name' => 'imap.example.com',
    'type' => 'MX'
));

foreach ($records as $record) {
    $recordId = $record->id;
}hjJ  hhh hh"}rc  (h’h“h']h&]h$]h%]rd  (h•X   phpre  eh*]uh,KLh-hh.]rf  h˜)rg  }rh  (hXž   $records = $domain->recordList(array(
    'name' => 'imap.example.com',
    'type' => 'MX'
));

foreach ($records as $record) {
    $recordId = $record->id;
}h"}ri  (h$]h%]rj  Uotherrk  ah&]h']h*]uhja  h.]rl  h7Xž   $records = $domain->recordList(array(
    'name' => 'imap.example.com',
    'type' => 'MX'
));

foreach ($records as $record) {
    $recordId = $record->id;
}rm  …rn  }ro  (hU hjg  ubah h¢ubaubeubeubhhh h!h"}rp  (h$]h%]h&]h']rq  Uquery-parametersrr  ah*]rs  hauh,K.h-hh.]rt  (h0)ru  }rv  (hX   Query parametersrw  hhhhh h4h"}rx  (h$]h%]h&]h']h*]uh,K.h-hh.]ry  h7X   Query parametersrz  …r{  }r|  (hjw  hju  ubaubh;)r}  }r~  (hXR   You can pass in an array of query parameters for greater control over
your search:r  hhhhh h?h"}r€  (h$]h%]h&]h']h*]uh,K0h-hh.]r  h7XR   You can pass in an array of query parameters for greater control over
your search:r‚  …rƒ  }r„  (hj  hj}  ubaubeubhhh Usystem_messager…  h"}r†  (h$]UlevelKh']h&]Usourcehh%]h*]UlineK3UtypeUERRORr‡  uh,K;h-hh.]rˆ  (h;)r‰  }rŠ  (hU h"}r‹  (h$]h%]h&]h']h*]uhhh.]rŒ  h7X   Malformed table.r  …rŽ  }r  (hU hj‰  ubah h?ubh)r  }r‘  (hXN  +------------+--------------+------------------------+---------------+
| Name       | Data type    | Default                | Description   |
+============+==============+========================+===============+
| ``type``   | ``string``   | The record type        |
+------------+--------------+------------------------+---------------+
| ``name``   | ``string``   | The record name        |
+------------+--------------+------------------------+---------------+
| ``data``   | ``string``   | Data for this record   |
+------------+--------------+------------------------+---------------+h"}r’  (h’h“h']h&]h$]h%]h*]uhhh.]r“  h7XN  +------------+--------------+------------------------+---------------+
| Name       | Data type    | Default                | Description   |
+============+==============+========================+===============+
| ``type``   | ``string``   | The record type        |
+------------+--------------+------------------------+---------------+
| ``name``   | ``string``   | The record name        |
+------------+--------------+------------------------+---------------+
| ``data``   | ``string``   | Data for this record   |
+------------+--------------+------------------------+---------------+r”  …r•  }r–  (hU hj  ubah hubeubaUcurrent_sourcer—  NU
decorationr˜  NUautofootnote_startr™  KUnameidsrš  }r›  (hj  hhphjN  h	hÝh
hûhjr  hh)hh¯uh.]rœ  hah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©  h-h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À  UentryrÁ  Ulanguage_coderÂ  UenrÃ  U	datestamprÄ  NUreport_levelrÅ  KU_destinationrÆ  NU
halt_levelrÇ  KUstrip_classesrÈ  Nh4NU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ø  ]rù  Ufile_insertion_enabledrú  ˆUraw_enabledrû  KUdump_settingsrü  NubUsymbol_footnote_startrý  K Uidsrþ  }rÿ  (jN  jJ  h)hj  hhphlh¯h«hûh÷jr  hhÝhÙuUsubstitution_namesr   }r  h h-h"}r  (h$]h']h&]Usourcehh%]h*]uU	footnotesr  ]r  Urefidsr  }r  ub.