Contents

Recovery Appliances
*****************

.. rb:class:: OneAndOne::RecoveryAppliance()
   
   The :rb:class:`RecoveryAppliance` class allows a user to perform actions against the 1and1 API.


   .. rb:method:: list(page: nil, per_page: nil, sort: nil, q: nil, fields: nil)

     List all images available for recovering purposes.

     :param page: Allows the use of pagination. Indicate which page to start on.
     :type page: ``int``

     :param per_page: Number of items per page.
     :type per_page: ``int``

     :param sort: ``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.
     :type sort: ``str``

     :param q: ``q`` is for query. Use this parameter to return only the items 
       that match your search query.
     :type q: ``str``

     :param fields: Returns only the parameters requested. 
       (i.e. fields: 'id, name, description, hardware.ram')
     :type fields: ``str``

     :rtype: JSON


   .. rb:method:: get(appliance_id: nil)

     Returns information about a recovery appliance.

     :param appliance_id: the unique identifier for the appliance.
     :type appliance_id: ``str``

     :rtype: JSON

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
1and1-1.3.0	sphinx/recovery_appliances.rst
1and1-1.2.0	sphinx/recovery_appliances.rst