€cdocutils.nodes document q)q}q(U nametypesq}q(Xserver appliancesqNXlistqˆXgetqˆuUsubstitution_defsq }q Uparse_messagesq ]q Ucurrent_sourceq NU decorationqNUautofootnote_startqKUnameidsq}q(hUserver-appliancesqhhhhuUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqXY/Users/tyler-macbook/Projects/oneandone-cloudserver-sdk-ruby/sphinx/server_appliances.rstqUtagnameqUsectionqU attributesq}q(Udupnamesq ]Uclassesq!]Ubackrefsq"]Uidsq#]q$haUnamesq%]q&hauUlineq'KUdocumentq(hh]q)(cdocutils.nodes title q*)q+}q,(hXServer Appliancesq-hhhhhUtitleq.h}q/(h ]h!]h"]h#]h%]uh'Kh(hh]q0cdocutils.nodes Text q1XServer Appliancesq2…q3}q4(hh-hh+ubaubcsphinx.addnodes index q5)q6}q7(hUhhhNhUindexq8h}q9(h#]h"]h ]h!]h%]Uentries]uh'Nh(hh]ubcsphinx.addnodes desc q:)q;}q<(hUhhhNhUdescq=h}q>(Unoindexq?‰Udomainq@Xrbh#]h"]h ]h!]h%]UobjtypeqAXclassqBUdesctypeqChBuh'Nh(hh]qD(csphinx.addnodes desc_signature qE)qF}qG(hXOneAndOne::ServerAppliance()qHhh;hhhUdesc_signatureqIh}qJ(h#]h"]h ]h!]h%]UfirstqK‰uh'K*h(hh]qLcsphinx.addnodes desc_name qM)qN}qO(hhHhhFhhhU desc_nameqPh}qQ(h ]h!]h"]h#]h%]uh'K*h(hh]qRh1XOneAndOne::ServerAppliance()qS…qT}qU(hUhhNubaubaubcsphinx.addnodes desc_content qV)qW}qX(hUhh;hhhU desc_contentqYh}qZ(h ]h!]h"]h#]h%]uh'K*h(hh]q[(cdocutils.nodes paragraph q\)q]}q^(hX]The :rb:class:`ServerAppliance` class allows a user to perform actions against the 1and1 API.q_hhWhhhU paragraphq`h}qa(h ]h!]h"]h#]h%]uh'Kh(hh]qb(h1XThe qc…qd}qe(hXThe hh]ubcsphinx.addnodes pending_xref qf)qg}qh(hX:rb:class:`ServerAppliance`qihh]hhhU pending_xrefqjh}qk(UreftypeXclassU rb:moduleqlNUrefwarnqm‰U reftargetqnXServerApplianceU refdomainXrbqoh#]Urb:classqpNh"]U refexplicit‰h ]h!]h%]UrefdocqqXserver_appliancesqruh'Kh]qscdocutils.nodes literal qt)qu}qv(hhih}qw(h ]h!]qx(UxrefqyhoXrb-classqzeh"]h#]h%]uhhgh]q{h1XServerApplianceq|…q}}q~(hUhhuubahUliteralqubaubh1X> class allows a user to perform actions against the 1and1 API.q€…q}q‚(hX> class allows a user to perform actions against the 1and1 API.hh]ubeubh5)qƒ}q„(hUhhWhNhh8h}q…(h#]h"]h ]h!]h%]Uentries]q†(Usingleq‡X () ( method)hhtqˆauh'Nh(hh]ubh:)q‰}qŠ(hUhhWhNhh=h}q‹(h?‰h@Xrbh#]h"]h ]h!]h%]hAXmethodqŒhChŒuh'Nh(hh]q(hE)qŽ}q(hX>list(page: nil, per_page: nil, sort: nil, q: nil, fields: nil)hh‰hhhhIh}q(h#]q‘haUmoduleq’Nh"]h ]h!]h%]q“haUfullnameq”hUclassq•UhK‰uh'K"h(hh]q–(hM)q—}q˜(hhhhŽhhhhPh}q™(h ]h!]h"]h#]h%]uh'K"h(hh]qšh1Xlistq›…qœ}q(hUhh—ubaubcsphinx.addnodes desc_parameterlist qž)qŸ}q (hX8page: nil, per_page: nil, sort: nil, q: nil, fields: nilhhŽhhhUdesc_parameterlistq¡h}q¢(h ]h!]h"]h#]h%]uh'K"h(hh]q£(csphinx.addnodes desc_parameter q¤)q¥}q¦(hX page: nilhhŸhhhUdesc_parameterq§h}q¨(h ]h!]h"]h#]h%]uh'K"h(hh]q©h1X page: nilqª…q«}q¬(hUhh¥ubaubh¤)q­}q®(hX per_page: nilhhŸhhhh§h}q¯(h ]h!]h"]h#]h%]uh'K"h(hh]q°h1X per_page: nilq±…q²}q³(hUhh­ubaubh¤)q´}qµ(hX sort: nilhhŸhhhh§h}q¶(h ]h!]h"]h#]h%]uh'K"h(hh]q·h1X sort: nilq¸…q¹}qº(hUhh´ubaubh¤)q»}q¼(hXq: nilhhŸhhhh§h}q½(h ]h!]h"]h#]h%]uh'K"h(hh]q¾h1Xq: nilq¿…qÀ}qÁ(hUhh»ubaubh¤)qÂ}qÃ(hX fields: nilhhŸhhhh§h}qÄ(h ]h!]h"]h#]h%]uh'K"h(hh]qÅh1X fields: nilqÆ…qÇ}qÈ(hUhhÂubaubeubeubhV)qÉ}qÊ(hUhh‰hhhhYh}qË(h ]h!]h"]h#]h%]uh'K"h(hh]qÌ(h\)qÍ}qÎ(hXList all server appliances.qÏhhÉhhhh`h}qÐ(h ]h!]h"]h#]h%]uh'K h(hh]qÑh1XList all server appliances.qÒ…qÓ}qÔ(hhÏhhÍubaubcdocutils.nodes field_list qÕ)qÖ}q×(hUhhÉhNhU field_listqØh}qÙ(h ]h!]h"]h#]h%]uh'Nh(hh]qÚ(cdocutils.nodes field qÛ)qÜ}qÝ(hUh}qÞ(h ]h!]h"]h#]h%]uhhÖh]qß(cdocutils.nodes field_name qà)qá}qâ(hX Parametersh}qã(h ]h!]h"]h#]h%]uhhÜh]qäh1X Parametersqå…qæ}qç(hUhháubahU field_nameqèubcdocutils.nodes field_body qé)qê}që(hUh}qì(h ]h!]h"]h#]h%]uhhÜh]qícdocutils.nodes bullet_list qî)qï}qð(hUh}qñ(h ]h!]h"]h#]h%]uhhêh]qò(cdocutils.nodes list_item qó)qô}qõ(hUh}qö(h ]h!]h"]h#]h%]uhhïh]q÷h\)qø}qù(hXLpage (int) -- Allows the use of pagination. Indicate which page to start on.h}qú(h ]h!]h"]h#]h%]uhhôh]qû(csphinx.addnodes literal_strong qü)qý}qþ(hXpageh}qÿ(h ]h!]h"]h#]h%]uhhøh]rh1Xpager…r}r(hUhhýubahUliteral_strongrubh1X (r…r}r(hUhhøubht)r}r (hX``int``r h}r (h ]h!]h"]h#]h%]uhhøh]r h1Xintr …r}r(hUhjubahhubh1X)…r}r(hUhhøubh1X -- r…r}r(hUhhøubh1X>Allows the use of pagination. Indicate which page to start on.r…r}r(hX>Allows the use of pagination. Indicate which page to start on.rhhøubehh`ubahU list_itemrubhó)r}r(hUh}r(h ]h!]h"]h#]h%]uhhïh]rh\)r}r(hX+per_page (int) -- Number of items per page.h}r (h ]h!]h"]h#]h%]uhjh]r!(hü)r"}r#(hXper_pageh}r$(h ]h!]h"]h#]h%]uhjh]r%h1Xper_pager&…r'}r((hUhj"ubahjubh1X (r)…r*}r+(hUhjubht)r,}r-(hX``int``r.h}r/(h ]h!]h"]h#]h%]uhjh]r0h1Xintr1…r2}r3(hUhj,ubahhubh1X)…r4}r5(hUhjubh1X -- r6…r7}r8(hUhjubh1XNumber of items per page.r9…r:}r;(hXNumber of items per page.r<hjubehh`ubahjubhó)r=}r>(hUh}r?(h ]h!]h"]h#]h%]uhhïh]r@h\)rA}rB(hX´sort (str) -- sort: 'name' retrieves a list of elements sorted alphabetically. sort: 'creation_date' retrieves a list of elements sorted by their creation date in descending order.h}rC(h ]h!]h"]h#]h%]uhj=h]rD(hü)rE}rF(hXsorth}rG(h ]h!]h"]h#]h%]uhjAh]rHh1XsortrI…rJ}rK(hUhjEubahjubh1X (rL…rM}rN(hUhjAubht)rO}rP(hX``str``rQh}rR(h ]h!]h"]h#]h%]uhjAh]rSh1XstrrT…rU}rV(hUhjOubahhubh1X)…rW}rX(hUhjAubh1X -- rY…rZ}r[(hUhjAubht)r\}r](hX``sort: 'name'``h}r^(h ]h!]h"]h#]h%]uhjAh]r_h1X sort: 'name'r`…ra}rb(hUhj\ubahhubh1X5 retrieves a list of elements sorted alphabetically. rc…rd}re(hX5 retrieves a list of elements sorted alphabetically. hjAubht)rf}rg(hX``sort: 'creation_date'``h}rh(h ]h!]h"]h#]h%]uhjAh]rih1Xsort: 'creation_date'rj…rk}rl(hUhjfubahhubh1XP retrieves a list of elements sorted by their creation date in descending order.rm…rn}ro(hXP retrieves a list of elements sorted by their creation date in descending order.hjAubehh`ubahjubhó)rp}rq(hUh}rr(h ]h!]h"]h#]h%]uhhïh]rsh\)rt}ru(hXdq (str) -- q is for query. Use this parameter to return only the items that match your search query.h}rv(h ]h!]h"]h#]h%]uhjph]rw(hü)rx}ry(hXqh}rz(h ]h!]h"]h#]h%]uhjth]r{h1Xq…r|}r}(hUhjxubahjubh1X (r~…r}r€(hUhjtubht)r}r‚(hX``str``rƒh}r„(h ]h!]h"]h#]h%]uhjth]r…h1Xstrr†…r‡}rˆ(hUhjubahhubh1X)…r‰}rŠ(hUhjtubh1X -- r‹…rŒ}r(hUhjtubht)rŽ}r(hX``q``h}r(h ]h!]h"]h#]h%]uhjth]r‘h1Xq…r’}r“(hUhjŽubahhubh1XX is for query. Use this parameter to return only the items that match your search query.r”…r•}r–(hXX is for query. Use this parameter to return only the items that match your search query.hjtubehh`ubahjubhó)r—}r˜(hUh}r™(h ]h!]h"]h#]h%]uhhïh]ršh\)r›}rœ(hXkfields (str) -- Returns only the parameters requested. (i.e. fields: 'id, name, description, hardware.ram')h}r(h ]h!]h"]h#]h%]uhj—h]rž(hü)rŸ}r (hXfieldsh}r¡(h ]h!]h"]h#]h%]uhj›h]r¢h1Xfieldsr£…r¤}r¥(hUhjŸubahjubh1X (r¦…r§}r¨(hUhj›ubht)r©}rª(hX``str``r«h}r¬(h ]h!]h"]h#]h%]uhj›h]r­h1Xstrr®…r¯}r°(hUhj©ubahhubh1X)…r±}r²(hUhj›ubh1X -- r³…r´}rµ(hUhj›ubh1X[Returns only the parameters requested. (i.e. fields: 'id, name, description, hardware.ram')r¶…r·}r¸(hX[Returns only the parameters requested. (i.e. fields: 'id, name, description, hardware.ram')r¹hj›ubehh`ubahjubehU bullet_listrºubahU field_bodyr»ubehUfieldr¼ubhÛ)r½}r¾(hUh}r¿(h ]h!]h"]h#]h%]uhhÖh]rÀ(hà)rÁ}rÂ(hX Return typeh}rÃ(h ]h!]h"]h#]h%]uhj½h]rÄh1X Return typerÅ…rÆ}rÇ(hUhjÁubahhèubhé)rÈ}rÉ(hUh}rÊ(h ]h!]h"]h#]h%]uhj½h]rËh\)rÌ}rÍ(hXJSONh}rÎ(h ]h!]h"]h#]h%]uhjÈh]rÏh1XJSONrÐ…rÑ}rÒ(hXJSONrÓhjÌubahh`ubahj»ubehj¼ubeubeubeubh5)rÔ}rÕ(hUhhWhNhh8h}rÖ(h#]h"]h ]h!]h%]Uentries]r×(h‡X () ( method)hhtrØauh'Nh(hh]ubh:)rÙ}rÚ(hUhhWhNhh=h}rÛ(h?‰h@Xrbh#]h"]h ]h!]h%]hAXmethodrÜhCjÜuh'Nh(hh]rÝ(hE)rÞ}rß(hXget(appliance_id: nil)hjÙhhhhIh}rà(h#]ráhah’Nh"]h ]h!]h%]râhah”hh•UhK‰uh'K*h(hh]rã(hM)rä}rå(hhhjÞhhhhPh}ræ(h ]h!]h"]h#]h%]uh'K*h(hh]rçh1Xgetrè…ré}rê(hUhjäubaubhž)rë}rì(hXappliance_id: nilhjÞhhhh¡h}rí(h ]h!]h"]h#]h%]uh'K*h(hh]rîh¤)rï}rð(hXappliance_id: nilhjëhhhh§h}rñ(h ]h!]h"]h#]h%]uh'K*h(hh]ròh1Xappliance_id: nilró…rô}rõ(hUhjïubaubaubeubhV)rö}r÷(hUhjÙhhhhYh}rø(h ]h!]h"]h#]h%]uh'K*h(hh]rù(h\)rú}rû(hX'Returns information about an appliance.rühjöhhhh`h}rý(h ]h!]h"]h#]h%]uh'K%h(hh]rþh1X'Returns information about an appliance.rÿ…r}r(hjühjúubaubhÕ)r}r(hUhjöhNhhØh}r(h ]h!]h"]h#]h%]uh'Nh(hh]r(hÛ)r}r(hUh}r(h ]h!]h"]h#]h%]uhjh]r (hà)r }r (hX Parametersh}r (h ]h!]h"]h#]h%]uhjh]r h1X Parametersr…r}r(hUhj ubahhèubhé)r}r(hUh}r(h ]h!]h"]h#]h%]uhjh]rhî)r}r(hUh}r(h ]h!]h"]h#]h%]uhjh]rhó)r}r(hUh}r(h ]h!]h"]h#]h%]uhjh]rh\)r}r(hX>appliance_id (str) -- the unique identifier for the appliance.h}r(h ]h!]h"]h#]h%]uhjh]r (hü)r!}r"(hX appliance_idh}r#(h ]h!]h"]h#]h%]uhjh]r$h1X appliance_idr%…r&}r'(hUhj!ubahjubh1X (r(…r)}r*(hUhjubht)r+}r,(hX``str``r-h}r.(h ]h!]h"]h#]h%]uhjh]r/h1Xstrr0…r1}r2(hUhj+ubahhubh1X)…r3}r4(hUhjubh1X -- r5…r6}r7(hUhjubh1X(the unique identifier for the appliance.r8…r9}r:(hX(the unique identifier for the appliance.r;hjubehh`ubahjubahjºubahj»ubehj¼ubhÛ)r<}r=(hUh}r>(h ]h!]h"]h#]h%]uhjh]r?(hà)r@}rA(hX Return typeh}rB(h ]h!]h"]h#]h%]uhj<h]rCh1X Return typerD…rE}rF(hUhj@ubahhèubhé)rG}rH(hUh}rI(h ]h!]h"]h#]h%]uhj<h]rJh\)rK}rL(hXJSONh}rM(h ]h!]h"]h#]h%]uhjGh]rNh1XJSONrO…rP}rQ(hXJSONrRhjKubahh`ubahj»ubehj¼ubeubeubeubeubeubeubahUU transformerrSNU footnote_refsrT}rUUrefnamesrV}rWUsymbol_footnotesrX]rYUautofootnote_refsrZ]r[Usymbol_footnote_refsr\]r]U citationsr^]r_h(hU current_liner`NUtransform_messagesra]rbUreporterrcNUid_startrdKU autofootnotesre]rfU citation_refsrg}rhUindirect_targetsri]rjUsettingsrk(cdocutils.frontend Values rlorm}rn(Ufootnote_backlinksroKUrecord_dependenciesrpNU rfc_base_urlrqUhttps://tools.ietf.org/html/rrU tracebackrsˆUpep_referencesrtNUstrip_commentsruNU toc_backlinksrvUentryrwU language_coderxUenryU datestamprzNU report_levelr{KU _destinationr|NU halt_levelr}KU strip_classesr~Nh.NUerror_encoding_error_handlerrUbackslashreplacer€UdebugrNUembed_stylesheetr‚‰Uoutput_encoding_error_handlerrƒUstrictr„U sectnum_xformr…KUdump_transformsr†NU docinfo_xformr‡KUwarning_streamrˆNUpep_file_url_templater‰Upep-%04drŠUexit_status_levelr‹KUconfigrŒNUstrict_visitorrNUcloak_email_addressesrŽˆUtrim_footnote_reference_spacer‰UenvrNUdump_pseudo_xmlr‘NUexpose_internalsr’NUsectsubtitle_xformr“‰U source_linkr”NUrfc_referencesr•NUoutput_encodingr–Uutf-8r—U source_urlr˜NUinput_encodingr™U utf-8-sigršU_disable_configr›NU id_prefixrœUU tab_widthrKUerror_encodingržUUTF-8rŸU_sourcer hUgettext_compactr¡ˆU generatorr¢NUdump_internalsr£NU smart_quotesr¤‰U pep_base_urlr¥U https://www.python.org/dev/peps/r¦Usyntax_highlightr§Ulongr¨Uinput_encoding_error_handlerr©j„Uauto_id_prefixrªUidr«Udoctitle_xformr¬‰Ustrip_elements_with_classesr­NU _config_filesr®]Ufile_insertion_enabledr¯ˆU raw_enabledr°KU dump_settingsr±NubUsymbol_footnote_startr²KUidsr³}r´(hjÞhhŽhhuUsubstitution_namesrµ}r¶hh(h}r·(h ]h#]h"]Usourcehh!]h%]uU footnotesr¸]r¹Urefidsrº}r»ub.