Controller: /siteworx/backup/schedule
=====================================

:Required Permissions: BACKUP
:Required Options: Account Backup

Action: ``create``
------------------

:Added in Version: 4.8.0-393
:Description: Add a scheduled backup.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``frequency``
     - string
     - Yes
     - weekly, monthly
     - 
     - 
   * - ``type``
     - string
     - Yes
     - full, partial, structure
     - 
     - 
   * - ``location``
     - string
     - Yes
     - siteworx, local, ftp, scp
     - 
     - 
   * - ``email_address``
     - string
     - No*
     - 
     - user@example.com
     - 
   * - ``rotate``
     - integer
     - No*
     - 
     - 4
     - Indicates the maximum number of backups to keep before removing old backups.
   * - ``hour``
     - integer
     - No*
     - 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
     - 0
     - 
   * - ``day_of_week``
     - integer
     - Yes
     - 0, 1, 2, 3, 4, 5, 6
     - 
     - 

\* indicates that it's actually required, but probably already has a valid default value.

Action: ``delete``
------------------

:Added in Version: 4.8.0-393
:Description: Deletes the scheduled backup.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``scheduled``
     - struct (integer)
     - Yes
     - 1
     - 
     - 

Action: ``edit``
----------------

:Added in Version: 5.0.14-579
:Description: Edit a scheduled backup.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``id``
     - integer
     - Yes
     - 
     - 
     - 
   * - ``frequency``
     - string
     - Yes
     - daily, weekly, monthly
     - 
     - 
   * - ``type``
     - string
     - Yes
     - full, partial, structure
     - 
     - 
   * - ``location``
     - string
     - Yes
     - siteworx, local, ftp, scp
     - 
     - 
   * - ``email_address``
     - string
     - No*
     - 
     - user@example.com
     - 
   * - ``rotate``
     - integer
     - No*
     - 
     - 2
     - Indicates the maximum number of backups to keep before removing old backups.
   * - ``hour``
     - integer
     - No*
     - 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
     - 1
     - 

\* indicates that it's actually required, but probably already has a valid default value.

Action: ``fail``
----------------

:Added in Version: n/a
:Description: Magic function - test for failure mechanism.

Action: ``listScheduled``
-------------------------

:Added in Version: 4.8.0-393
:Description: Lists all the scheduled backups for the current SiteWorx user.

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       0 => 
       array (
         'id' => 1,
         'siteworx_id' => 1,
         'email_address' => 'user@example.com',
         'rotate' => 2,
         'frequency' => 'daily',
         'hour' => '1',
         'day_of_month' => '*',
         'day_of_week' => '*',
         'type' => 'structure',
         'backup_dbs' => 0,
         'backup_web' => 0,
         'backup_mail' => 0,
         'location' => 'siteworx',
         'location_data' => '[]',
       ),
     ),
     'reply_code' => 205,
   )


Action: ``queryEdit``
---------------------

:Added in Version: 5.1.0-838
:Description: Displays the information available to the action "edit".

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``id``
     - integer
     - Yes
     - 
     - 
     - 
   * - ``frequency``
     - string
     - Yes
     - daily, weekly, monthly
     - 
     - 
   * - ``type``
     - string
     - Yes
     - full, partial, structure
     - 
     - 
   * - ``location``
     - string
     - Yes
     - siteworx, local, ftp, scp
     - 
     - 

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       'siteworx_id' => '1',
       'email_address' => 'user@example.com',
       'type_copy' => 'full',
       'location_copy' => 'siteworx',
       'rotate' => '2',
       'frequency_copy' => 'daily',
       'hour' => '1',
       'day_of_week' => '*',
       'day_of_month' => '*',
       'id' => '1',
       'frequency' => 'daily',
       'type' => 'full',
       'location' => 'siteworx',
     ),
     'reply_code' => 205,
   )


Action: ``reroute``
-------------------

:Added in Version: n/a
:Description: Action to re-route from the current controller to a different one.

Action: ``wait``
----------------

:Added in Version: 8.1.3-2998
:Description: Magic function - used to simulate a long-running process

Action: ``win``
---------------

:Added in Version: n/a
:Description: Magic function - test for testing success mechanism.