Mobile Site Resources

Overview

A Site instance resource represents a single Duda site. There are two main types of Duda sites: Mobile and Multiscreen. Mobile represents a DudaMobile site and Multiscreen represents a DudaOne site. Below, you will see all the available resources for the mobile only product.

Resource URIs

  • Create Site

    Call the Duda API to create a new site. This site will be created in the account associated with the API key you are using. The site name you use must be unique on the Duda platform.

    POST /sites/mobile/create

    Parameters:

    The JSON structure that should be passed as request body:

    PropertyTypeRequiredDescription

    site_data Site required parameter of type Site (see below)
    publish_now* Boolean optional Whether the created site should be published immediately. Possible values ("true", "false"). Default: "false"
    create_now String (true, false, async) optional The create now option allows you to change when the site will be created. By default it will create at the time of your POST ("true"), but you can define "false" to delay creation until the site is accessed or "async" to try and create it now, but without blocking the response.

    Site resource properties for site creation (site_data):

    PropertyTypeRequiredDescription

    site_name string optional If provided must be unique value across all Sites in the system (at least 4 chars, max 45 chars). If not provided the unique name will be generated (and returned) based on original_site_url
    original_site_url url required The desktop site URL that Duda will use to base mobile site off of. (max 2048 chars)
    preview_site_url url optional The desktop website's preview URL for use during mobile website editing. If null, original_site_url is used. (max 2048 chars)
    site_domain url optional The custom domain that will be used on the mobile site. Most people choose ‘m.example.com’, but others can be used (max 253 chars).
    auto_sync_cache_ttl String optional Either: VERY_SHORT, SHORT, LONG, VERY_LONG.
    This is how long the cache on the mobile site will be stored. This is how frequently Duda will check the desktop site for updates in order to perform auto-sync. The default value is SHORT of 2 Hours.
    site_vertical String optional Providing a vertical helps Duda improve the conversion of the site so we can implement layout best practices. Example: Business
    site_vertical_category String optional Example: Restaurant
    business_site_info Business Site InfoData Structure optional If phone number is provided in create site will populate a ‘click-to-call’ button with the phone number that is passed. If address is provided in create site will populate a ‘mobile map’ button with the address that is passed.
    opentable_info OpenTableData Structure optional If provided, will create an OpenTable button with the information provided. You can pass multiple in order for the button to have multiple locations associated with it.
    external_uid string optional A flexible string you pass to Duda when creating the site, allows you to store your customers unique value to reference later (max 45 chars).

    An Address data structure is used by multiple Site APIs and is represented by the following properties. Providing an address helps the site creation process by giving Duda more information about the location of the site. For example, if you provide an address we will automatically populate a mobile maps button and potentially find other resources online.

    PropertyTypeDescription

    Street string  
    City string  
    State string  
    Country string  
    zip_code numeric string  

    An OpenTable Info data structure is used by multiple Site APIs and is represented by the properties below. Providing this will create an OpenTable button and help Duda find more information about the website online.

    PropertyTypeDescription

    restaurant_id string Ex: 111
    location string Ex: Downtown San Francisco
    country string Ex: US

    A Site Business Info data structure is used by multiple Site APIs and is represented by the properties below. Providing this information during site creation improves the conversion of the mobile site and helps populate site data.

    PropertyTypeDescription

    business_name string  
    phone_number string  
    address Address (as defined above)  
    opentable_info Array of one or more OpenTable Info data structures (as defined above) for each restaurant location. Ex: [ {"restaurant_id":"111", "location":"San Francisco",
    "country":"US"} ]

    Return:

    The following JSON structure :

    PropertyTypeDescription

    site_name string The site name of the create mobile Site.

    Example return:

    {"site_name":"de6f096c-10e0-47d41-bcde-c685b401f653"}

    Errors:

    ResourceAlreadyExist

    InvalidInput

    CURL Example:

    Data easily read:
    {
      "site_data": {
        "site_name": "de6f096c-10e0-47d4-bcde-c685b401f653",
        "original_site_url": "http://www.domenicosdeli.com",
        "site_domain": "http://m.abcz.com",
        "auto_sync_cache_ttl": "VERY_SHORT",
        "site_vertical": "Business",
        "site_vertical_category": "Restaurant",
        "site_business_info":
        {
          "business_name": "Open Market",
          "phone_number": "4157775577",
          "address":
          {
              "country": "US",
              "city": "San Francisco",
              "state": "CA",
              "street": "1 Market Street",
              "zip_pre": "94111"
          },
          "opentable_info": [
                { "restaurant_id": "4", "location": "San Francisco", "country": "US" },
                { "restaurant_id": "44", "location": "Chicago", "country": "US" }
          ],
        },
        "external_uid": "AD342"
      },
      "publish_now": "false",
      "create_now": "true"
    }

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X POST -i -k https://api.dudamobile.com/api/sites/mobile/create -d '{"site_data": {"site_name": "de6f096c-10e0-47d41-bcde-c685b401f653","original_site_url": "http://www.domenicosdeli.com","site_domain": "http://m.a3bcz.com","auto_sync_cache_ttl": "VERY_SHORT","site_vertical": "Business","site_vertical_category": "Restaurant","site_business_info":{"business_name": "Open Market","phone_number": "4157775577","address":{"country": "US","city": "San Francisco","state": "CA","street": "1 Market Street","zip_code": "94111"},"opentable_info": [{ "restaurant_id": "4", "location": "San Francisco", "country": "US" },{ "restaurant_id": "44", "location": "Chicago", "country":"US" }]},"external_uid": "AD3423"},"publish_now": "false","create_now": "true"}'
  • Retrieve Site

    Use this call to get information about an existing site. You should already know the site name, as you provided it when originally creating the site.

    GET /sites/mobile/{site_name}

    Parameters:

    • site_name - URL parameter - site name

    Return:

    The following JSON structure representing the Site:

    PropertyTypeDescription

    site_name string The mobile site name. The site name is a unique identifier of the mobile Site.
    original_site_url url The desktop website's runtime URL for use during Duda production runtime.
    preview_site_url url The desktop website's preview URL for use during mobile website editing. If null, original_site_url is used.
    site_domain url The mobile site domain
    auto_sync_cache_ttl String Either: VERY_SHORT, SHORT, LONG, VERY_LONG
    site_vertical String Example: Business
    site_vertical_category String Example: Restaurant
    business_site_info Business Site Info Data Structure  
    external_uid string Optional placeholder to be used to reference/link the created Site to some unique identifier origin from external system
    last_published_date date, in UTC: YYYY-MM-DDThh:mm:ss The last time the site was published, if the site is currently published.
    last_confirmed_redirected_date date, in UTC: YYYY-MM-DDThh:mm:ss The last occurrence of the mobile site's retrieval as a consequence of the client having been redirected from the original site
    status String If site created with "async" option will have UNDER_CONSTRUCTION value until site creation is completed or failed. For properly created site this filed is ommited from response.
    creation_status String If site created with "async" option may have either PENDING (in creation) or FAILED_FRAMESET_UNSUPPORTED, FAILED_CONTENT_TOO_BIG, FAILED if site creation has failed. For properly created site this filed is ommited from response.

    JSON Response example:

    {
       "site_name":"de6f096c-10e0-47d41-bcde-c685b401f653",
       "account_name":"johnsmith@gmail.com",
       "site_domain":"m.abcz.com",
       "site_business_info":{
          "business_name":"Open Market",
          "address":{
             "street":"1 Market Street",
             "city":"San Francisco",
             "state":"CA",
             "country":"US",
             "zip_code":"94111"
          },
          "phone_number":"4157775577",
          "opentable_info":[
             {
                "restaurant_id":"44",
                "country":"US",
                "location":"Chicago"
             },
             {
                "country":"US",
                "location":"Open University"
             },
             {
                "restaurant_id":"4",
                "country":"US",
                "location":"San Francisco"
             }
          ]
       },
       "external_uid":"AD3423",
       "original_site_url":"http://www.domenicosdeli.com",
       "auto_sync_cache_ttl":"VERY_SHORT",
       "site_vertical":"Business",
       "site_vertical_category":"Restaurant",
       "site_extra_info":{
          "preview_url":"http://preview.domain.com/site/de6f096c-10e0-47d41-bcde-c685b401f653?dm_try_mode=true",
          "before_after_preview_url":"http://preview.domain.com /compare/de6f096c-10e0-47d41-bcde-c685b401f653"
       }
    }

    Possible Errors:

    ResourceNotExist

    CURL Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X POST -i -k https://api.dudamobile.com/api/sites/mobile/de6f096c-10e0-47d41-bcde-c685b401f653
  • Retrieve Site by External ID

    This will return information about an existing, much like retrieve site. Instead of supplying a site_name, you will send the external_uid you originally supplied when making the site.

    GET /sites/mobile/byexternal/{external_uid}

    Parameters:

    • external_uid - Unique identifier used to reference the site

    Return:

    The following JSON structure representing the Site:

    PropertyTypeDescription

    site_name string The mobile site name. The site name is a unique identifier of the mobile Site.
    original_site_url url The desktop website's runtime URL for use during Duda production runtime.
    site_domain url The mobile site domain
    auto_sync_cache_ttl String Either: VERY_SHORT, SHORT, LONG, VERY_LONG
    site_vertical String Example: Business
    site_vertical_category String Example: Restaurant
    business_site_info Business Site Info Data Structure  
    external_uid string Optional placeholder to be used to reference/link the created Site to some unique identifier origin from external system
    last_published_date date, in UTC: YYYY-MM-DDThh:mm:ss The last time the site was published, if the site is currently published.
    last_confirmed_redirected_date date, in UTC: YYYY-MM-DDThh:mm:ss The last occurrence of the mobile site's retrieval as a consequence of the client having been redirected from the original site

    JSON Example response:

    {
       "site_name":"de6f096c-10e0-47d41-bcde-c685b401f653",
       "account_name":"russ@dudamobile.com",
       "site_domain":"m.a3bcz.com",
       "site_business_info":{
          "business_name":"Open Market",
          "address":{
             "street":"1 Market Street",
             "city":"San Francisco",
             "state":"CA",
             "country":"US",
             "zip_code":"94111"
          },
          "phone_number":"4157775577",
          "opentable_info":[
             {
                "restaurant_id":"44",
                "country":"US",
                "location":"Chicago"
             },
             {
                "country":"US",
                "location":"Open University"
             },
             {
                "restaurant_id":"4",
                "country":"US",
                "location":"San Francisco"
             }
          ]
       },
       "external_uid":"AD3423",
       "original_site_url":"http://www.domenicosdeli.com",
       "auto_sync_cache_ttl":"VERY_SHORT",
       "site_vertical":"Business",
       "site_vertical_category":"Restaurant",
       "site_extra_info":{
          "preview_url":"http://russ.dudamobile.biz/site/de6f..._try_mode=true",
          "before_after_preview_url":"http://russ.dudamobile.biz/compare/d...e-c685b401f653"
       }
    }

    Possible Errors:

    ResourceNotExist

    Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X GET -i -k https://api.dudamobile.com/api/sites/mobile/byexternal/AD3423
  • Update Site

    You can use this call to update proprieties about a site that is already created. The most common use for this would be to update the site_domain of an already created site or to adjust the cache timings.

    POST /sites/mobile/update/{site_name}

    Parameters:

    • site_name - URL parameter - site name

    The JSON structure that should be passed as request body (at least one of the fields should be present):

    PropertyTypeRequiredDescription

    site_domain fully qualified domain name Optional The mobile site domain name (max 253 chars)
    original_site_url url Optional The desktop website's runtime URL for use during Duda production runtime. (max 2048 chars)
    auto_sync_cache_ttl String Optional Either: VERY_SHORT, SHORT, LONG, VERY_LONG
    external_uid string Optional Placeholder for external system unique identifier. (max 45 chars)

    Return:

    • HTTP Code: 204 No Content

    Errors:

    ResourceNotExist

    InvalidInput

    CURL Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X POST -i -k https://api.dudamobile.com/api/sites/mobile/update/de6f096c-10e0-47d41-bcde-c685b401f653 -d '{"site_domain": "m.mysite.com"}'
  • Delete Site

    This will immediately and permanently delete the site and cancel any subscription associated with the site. Please note that after deleting a site there is no way to bring the site back.

    DELETE /sites/mobile/{site_name}

    Parameters:

    • site_name - URL parameter - site name

    Return:

    • HTTP Code: 204 No Content

    Errors:

    ResourceNotExist

    Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X DELETE -i -k https://api.dudamobile.com/api/sites/mobile/de6f096c-10e0-47d41-bcde-c685b401f653
  • Reset Site

    This will reset an existing site using the same proprieties that were originally used to create the site. Note: Any edits or changes made to the site will be lost during the recreate.

    POST /sites/mobile/recreate/{site_name}

    Parameters:

    • site_name - URL parameter - site name

    The JSON structure that may optionally be POSTed:

    PropertyTypeRequiredDescription

    republish true / false Optional Whether or not to republish the site being recreated. Default: false

    Return:

    • 204 No Content

    Errors:

    ResourceNotExist

    Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X POST -i -k https://api.dudamobile.com/api/sites/mobile/recreate/de6f096c-10e0-47d41-bcde-c685b401f653
  • Publish Site

    Takes the development version of the site and copies it to production. Publishing a site for the first time will also charge your account and create a new subscription unless you have included the test parameter. You can publish a site at any time, which will overwrite the production version of the site with the development version.

    POST /sites/mobile/publish/{site_name}

    Parameters:

    • site_name - URL parameter - site name

    Return:

    • HTTP Code: 204 No Content

    Errors:

    ResourceNotExist

    Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X POST -i -k https://api.dudamobile.com/api/sites/mobile/publish/de6f096c-10e0-47d41-bcde-c685b401f653
  • Unpublish Site

    Removes the mobile site from the production environment. This is good for disabling the mobile site or taking it down temporarily so no one can access it. Unpublishing a site does not cancel or pause the subscription.

    POST /sites/mobile/unpublish/{site_name}

    Parameters:

    • site_name - URL parameter - site name

    Return:

    • HTTP Code: 204 No Content

    Errors:

    ResourceNotExist

    Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X POST -i -k https://api.dudamobile.com/api/sites/mobile/unpublish/de6f096c-10e0-47d41-bcde-c685b401f653
  • Reset Published Site Cache

    This will reset the cache for a site on the production environment. Doing so allows the site to auto-sync the latest content from the desktop site, instead of waiting for the cache timer to expire.

    POST /sites/mobile/resetcache/{site_name}

    Parameters:

    • site_name - URL parameter - site name

    Return:

    • HTTP Code: 204 No Content

    Errors:

    ResourceNotExist

    Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X POST -i -k https://api.dudamobile.com/api/sites/mobile/resetcache/de6f096c-10e0-47d41-bcde-c685b401f653
  • Retrieve Sites created during given period

    Will return an array of site names created during the given time period. If no from parameter is specified, sites created in the past 7 days will be returned.

    GET /sites/mobile/created

    Query String Parameters:

    Query String ParameterTypeRequiredDescription

    from Date optional, defaults to 7 days prior to "to" value Start Date Used for Lookup (In UTC: YYYY-MM-DDThh:mm:ss OR YYYY-MM-DD)
    to Date optional, defaults to current date End Date Used for Lookup (In UTC: YYYY-MM-DDThh:mm:ss OR YYYY-MM-DD)

    Return:

    Array containing the following JSON structure representing the Sites:

    PropertyTypeDescription

    site_name string The mobile site name. The site name is a unique identifier of the mobile Site.

    Example JSON Response:

    [

    "tand970",

    "de6f096c-10e0-47d41-bcde-c685b401f653",

    "domenicosdeli"

    ]

    Errors:

    InvalidInput

    Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X GET -i -k https://api.dudamobile.com/api/sites/mobile/created?from=2014-03-01&to=2014-03-09
  • Retrieve Sites modified during given period

    GET /sites/mobile/modified

    Will return an array of site names modified during the given time period. If no from parameter is specified, sites modified in the past 7 days will be returned.

    Query String Parameters:

    Query String ParameterTypeRequiredDescription

    from Date optional, defaults to 7 days prior to "to" value Start Date Used for Lookup (In UTC: YYYY-MM-DDThh:mm:ss OR YYYY-MM-DD)
    to Date optional, defaults to current date End Date Used for Lookup (In UTC: YYYY-MM-DDThh:mm:ss OR YYYY-MM-DD)

    Return:

    Array containing the following JSON structure representing the Sites:

    PropertyTypeDescription

    site_name string The mobile site name. The site name is a unique identifier of the mobile Site.

    Example JSON Response:

    [

    "domenicosdeli_1",

    "tand_29",

    "domenicosdeli_62",

    "3b10c7e3"

    ]

    Errors:

    InvalidInput

    Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X GET -i -k https://api.dudamobile.com/api/sites/mobile/modified?from=2014-03-01&to=2014-03-09
  • Retrieve Multiple Sites

    By sending an array of site names you can retrieve information about multiple sites at once. This is much quicker than calling the retrieve site multiple times. A maximum of 50 sites can be retrieved at once.

    POST /sites/mobile/get-many

    Parameters:

    An Array should be posted included one or more items of the following JSON structure, identifying the sites requested (maximum of 50):

    PropertyTypeRequiredDescription

    site_name string required the site_name of a site requested

    Example JSON data:

    [
    {"site_name":"domenicosdeli_1"},
    {"site_name":"gand_88"}
    ]

    Return:

    The following JSON structure representing the Sites:

    PropertyTypeDescription

    site_name string The mobile site name. The site name is a unique identifier of the mobile Site.
    original_site_url url The desktop website's runtime URL for use during Duda production runtime.
    site_domain url The mobile site domain
    auto_sync_cache_ttl String Either: VERY_SHORT, SHORT, LONG, VERY_LONG
    site_vertical String Example: Business
    site_vertical_category String Example: Restaurant
    business_site_info Business Site Info Data Structure  
    external_uid string Optional placeholder to be used to reference/link the created Site to some unique identifier origin from external system
    last_published_date date, in UTC: YYYY-MM-DDThh:mm:ss The last time the site was published, if the site is currently published.
    last_confirmed_redirected_date date, in UTC: YYYY-MM-DDThh:mm:ss The last occurrence of the mobile site's retrieval as a consequence of the client having been redirected from the original site

    Example JSON Response:

    {
       "sites":[
          {
             "site_name":"domenicosdeli_1",
             "account_name":"johnsmith@gmail.com",
             "original_site_url":"http://domenicosdeli.com",
             "auto_sync_cache_ttl":"SHORT",
             "site_extra_info":{
                "preview_url":"http://preview.domain.com/site/domen..._try_mode=true",
                "before_after_preview_url":"http://preview.domain.com/compare/domenicosdeli_1"
             }
          },
          {
             "site_name":"gand_88",
             "account_name":"johnsmith@gmail.com",
             "last_published_date":"2013-10-08T01:49:11",
             "site_business_info":{
                "business_name":"Gand Music & Sound",
                "address":{
                   "street":"780 W. Frontage Road",
                   "city":"Northfield",
                   "state":"IL",
                   "country":"United States",
                   "zip_code":"60093"
                },
                "phone_number":"847-446-4263",
                "opentable_info":[
                   {
                      "country":"United States",
                      "location":"Gand Music & Sound"
                   }
                ]
             },
             "original_site_url":"http://gand.com",
             "auto_sync_cache_ttl":"SHORT",
             "site_vertical":"business",
             "site_vertical_category":"Financial Services",
             "site_extra_info":{
                "preview_url":"http://preview.domain.com/site/gand_..._try_mode=true",
                "before_after_preview_url":"http://preview.domain.com/compare/gand_88"
             }
          }
       ]
    }

    Errors:

    ResourceNotExist

    CURL Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X GET -i -k https://api.dudamobile.com/api/sites/mobile/get-many -d '[{"site_name":"domenicosdeli_1"},{"site_name":"gand_88"}]'
  • Duplicate Site

    Duplicate a mobile in it's current state. The new site will not be published or have any previous domain associations.

    POST /sites/mobile/duplicate/{site_name}

    Parameters: 

    site_name - URL parameter - site name

    new_site_name - JSON data structure with the new site name

    PropertyTypeRequiredDescription

    site_name string Required The mobile site name. The site name is a unique identifier of the mobile site. It was returned to you when the site was originally created.
    new_site_name string Optional Provide a new site name for the site. This will create a copy of the site site with the specified name. If you do not provide one, Duda will generate one for you.
    new_external_id string Optional Specify a new external user id to the newly duplicated site. 

    Response:

    • HTTP Code: 200 OK
    • JSON Example: {"site_name":"domenicosdeli_copy_1"}

    Errors:

    ResourceNotExist

    CURL Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X POST -i -k https://api.dudamobile.com/api/sites/mobile/duplicate/domenicosdeli_1 -d'{"new_site_name":"domenicosdeli_copy_1"}'
  • Get Contact Form Submissions

    Get all the contact form submissions that happened on the mobile site. This call will return an array of each contact form submissions. If you have different contact forms on your site and want to track them separately, you should change the title of the contact form in the contact form settings in the editor.

    GET /sites/mobile/get-forms/{site_name}

    Parameters:

    • site_name - URL parameter - site name

    URI Parameters:

    • Date - You can include a 'to' or 'from' parameter on the URL. This will limit the range of what get's returned. If no to or from is passed, Duda will return all form submissions for the site. 

    URI Parameter ValueTypeRequiredDescription

    to Date Optional Start Date Used for Lookup (In UTC: YYYY-MM-DDThh:mm:ss OR YYYY-MM-DD)
    from Date Optional End Date Used for Lookup (In UTC: YYYY-MM-DDThh:mm:ss OR YYYY-MM-DD)

    Response:

    PropertyTypeDescription

    form_title string The title of the contact form as it was set in Duda. This is controlled inside of the contact form settings.
    date string A time stamp of when the contact form submission occurred. The time zone will be in UTC.
    message array An array of all the contact form

    JSON example data returned:

    [
       {
          "form_title":"Contact Us",
          "message":{
             "Name":"test3",
             "Phone":"123-123-1234",
             "Dropdown":"Option 2",
             "Email":"test@test.com",
             "Message":"test message",
             "Radio button":"Option 2",
             "Date":"02/05/2014",
             "Check box":"Option 2"
          },
          "date":"2014-05-08T23:12:06"
       },
       {
          "form_title":"Contact Us",
          "message":{
             "Name":"test",
             "Phone":"abcc",
             "Email":"test@test.com",
             "Message":"123"
          },
          "date":"2014-05-08T22:34:50"
       }
    ]

    Errors:

    ResourceNotExist

    CURL Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X GET -i -k https://api.dudamobile.com/api/sites/mobile/get-forms/domenicosdeli_1
  • Get Site Backups

    Get an array of existing site backups/versions. A backup can be created from inside of the editor (or by API) and is also automatically created every time the site is published. Each site can have a maximum of 10 created backup versions and 5 that are automatically created upon each publish of the site (15 total). Backups that are automatically created will have a name such as: sitename_Auto_4

    GET /sites/mobile/backups/{site_name}

    Parameters:

    • site_name - URL parameter - site name

    Response:

    An array of site backups will be returned with the complete date and time (time is based on UTC) and the name of the backup.

    JSON example data returned:

    [
       {
          "date":"2014-06-07T11:18:51",
          "name":"russ7_Auto_3"
       },
       {
          "date":"2014-06-07T11:19:02",
          "name":"russ7_Auto_4"
       },
       {
          "date":"2014-06-07T11:19:13",
          "name":"russ7_Auto_5"
       },
       {
          "date":"2014-06-07T11:19:21",
          "name":"russ7_Auto_6"
       },
       {
          "date":"2014-06-07T11:29:49",
          "name":"russ7_Auto_7"
       },
       {
          "date":"2014-06-07T11:33:21",
          "name":"ManualBackup_1"
       }
    ]

    Errors:

    ResourceNotExist

    CURL Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X GET -i api/sites/mobile/backups/b4ra2g
  • Create Site Backup

    Create a new backup of a site. This is used for saving the existing state of a site. Good for saving a restore point before a user starts to edit a site or after work has been completeled.

    POST /sites/mobile/backups/{site_name}/create

    Parameters:

    • site_name - URL parameter - site name

    You can optionally define the name of the backup by sending a JSON message with the name set, for example:

    {
       "name":"via-api"
    }

    Response:

    If you provided a name for your backup, only an HTTP 200 response will be returned noting a successful backup creation. If you did not provide name, Duda will automatically create a name and return it to you in JSON format:

    {
       "backup_name":"russ7_12"
    }

    Errors:

    ResourceNotExist

    ResourceAlreadyExist

    CURL Example:

    1 curl -S -u 'APIusername:APIpassword' -H 'Content-Type: application/json' -X POST -i -d '{"name":"backup-via-api"}'https://my.dudamobile.com/api/sites/mobile/backups/b4ra2g/create
  • Restore site backup

    Restore a site from an existing backup. This will fully restore the site back to the state it was in at the time of the backup creation. When restoring a site, a backup is automatically made of the site before restoring the backup. You will be able to see the backup that is created via the Get Site Backups call.

    POST /sites/mobile/backups/{site_name}/restore/{backup_name}

    Parameters:

    • site_name - URL parameter - site name
    • backup_name - URL parameter - backup name

    Response:

    Upon successful completion a 204 response code will be returned.

    Errors:

    ResourceNotExist

    CURL Example:

    1 curl -S -u 'APIusername:APIpassword' -X POST -ihttps://my.dudamobile.com/api/sites/mobile/backups/b4ra2g/restore/via-api
  • Delete site backup

     Permanently delete a site backup. There is no way to restore or gain access to deleted site backups.

    DELETE /sites/mobile/backups/{site_name}/{backup_name}

    Parameters:

    • site_name - URL parameter - site name
    • backup_name - URL parameter - backup name

    Response:

    Upon successful completion a 204 response code will be returned.

    Errors:

    ResourceNotExist

    CURL Example:

    1 curl -S -u 'APIusername:APIpassword' -X DELETE -ihttps://my.dudamobile.com/api/sites/mobile/backups/b4ra2g/via-api
×

Priority Phone Support

English phone support is available 18 hours a day,
Monday through Friday, 3am to 9pm (EST).

United States +1 866-776-1550 3am to 9pm (Eastern)
United Kingdom +44 (0)800-011-9071 8am to 2am (London)
France +33 (0)9-75-18-84-74 9am to 3am (Paris)
Israel +972 (0)3-720-8922 10am to 4am (Jerusalem)
Australia +61 (0)2-8880-9166 7pm to 1pm (Sydney)
To schedule a call in French, Portuguese, Hebrew or Russian, please email us at prioritysupport@dudamobile.com
×

Please Log in as a DudaPro

Priority Phone Support is available exclusively to DudaPros. Log in to your DudaPro account now to see our international support numbers.

Log In
Not a DudaPro? Start a free trial now!