This is an archive version of the document. To get the most up-to-date information, see the current version.

(POST) /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Folders/Action

In this article

    Restores, sends and saves backed up SharePoint folders.

    Request

    To perform actions with backed up SharePoint folders, send the POST HTTPS request to the URL of the /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Folders/Action resource.

    HTTPS Request

    POST https://<Backup-Office365>:4443/v3/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Folders/Action

    Request Headers

    The request header must contain the authorization token for the current logon session.

    Request Body

    Restore List Folders

    To restore SharePoint list folders, the request body must contain the restoreTo action properties:

    Property

    Type

    Description

    UserName

    string

    Specifies the user name you want to use for authenticating with the organization.

    For example, "userName": "jsmith@westsupport.onmicrosoft.com".

    UserPassword

    string

    Specifies the user name you want to use for authenticating with the organization.

    For example, "userPassword": "paSSw0rd".

    List

    string

    Specifies the target SharePoint list.

    ChangedItems

    bool

    If set to True, indicates that the changed SharePoint items will be restored.

    For example, "changedItems": "true".

    DeletedItems

    bool

    If set to True, indicates that the deleted SharePoint items will be restored.

    For example, "deletedItems": "true".

    RestorePermissions

    bool

    If set to True, indicates that the SharePoint items will be restored with all permissions.

    For example, "restorePermissions": "true".

    SendSharedLinksNotification

    bool

    If set to True, indicates that shared links notifications will be sent.

    For example, "sendSharedLinksNotification": "true"

    DocumentVersion

    DocumentVersion

    Specifies, which of the following versions of the SharePoint documents will be restored:

    • all
    • last

    DocumentLastVersionAction

    DocumentLastVersionAction

    Specifies, which one of the following actions will be performed with the last versions of the restored SharePoint documents on the production server:

    • overwrite
    • merge

    For example:

    {

     "restoreTo":

     {"userName": "jsmith@westsupport.onmicrosoft.com",

      "userPassword": "paSSw0rd",

      "list": "listname",

      "changedItem": "true",

      "deletedItems": "true",

      "restorePermissions": "true",

      "documentVersion": "last",

      "documentLastVersionAction": "overwrite"

     }

    }

    Restore Library Folders

    To restore SharePoint library folders, the request body must contain the restoreTo action properties:

    Property

    Type

    Description

    UserName

    string

    Specifies the user name you want to use for authenticating with the organization.

    For example, "userName": "jsmith@westsupport.onmicrosoft.com".

    UserPassword

    string

    Specifies the user name you want to use for authenticating with the organization.

    For example, "userPassword": "paSSw0rd".

    List

    string

    Specifies the target SharePoint list.

    ChangedItems

    bool

    If set to True, indicates that the changed SharePoint items will be restored.

    For example, "changedItems": "true".

    DeletedItems

    bool

    If set to True, indicates that the deleted SharePoint items will be restored.

    For example, "deletedItems": "true".

    RestorePermissions

    bool

    If set to True, indicates that the SharePoint items will be restored with all permissions.

    For example, "restorePermissions": "true".

    SendSharedLinksNotification

    bool

    If set to True, indicates that shared links notifications will be sent.

    For example, "sendSharedLinksNotification": "true"

    DocumentVersion

    DocumentVersion

    Specifies, which of the following versions of the SharePoint documents will be restored:

    • all
    • last

    DocumentLastVersionAction

    DocumentLastVersionAction

    Specifies, which one of the following actions will be performed with the last versions of the restored SharePoint documents on the production server:

    • overwrite
    • merge

    For example:

    {

     "restoreTo":

     {"userName": "jsmith@westsupport.onmicrosoft.com",

      "userPassword": "paSSw0rd",

      "list": "listname",

      "changedItem": "true",

      "deletedItems": "true",

      "restorePermissions": "true",

      "documentVersion": "last",

      "documentLastVersionAction": "overwrite"

     }

    }

    Send Library Folders

    To send SharePoint library folders as attachments in an email message, the request body must contain the sendTo action:

    Property

    Type

    Description

    From

    string

    Specifies the email address from which library folders will be sent.

    For example, "from": "j_smith@bestsupport.onmicrosoft.com".

    To

    string

    Specifies the email address to which library folders will be sent.

    For example, "to": "r.clark@bestsupport.onmicrosoft.com".

    Subject

    string

    Specifies the subject of the email message used for sending library folders.

    For example,  "subject": "Support Ticket".

    Text

    string

    Specifies the body of the email message used for sending library folders.

    For example, "text": "Please find attached the files you requested".

    For example:

    {

     "sendTo":

     {"from": "j_smith@bestsupport.onmicrosoft.com",

      "to": "r.clark@bestsupport.onmicrosoft.com",

      "subject": "Support Ticket",

      "text": "Please find attached the files you requested"

     }

    }

     

    (POST) /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Folders/Action Note:

    To be able to send library folders as attachments you must specify the VESP email settings by sending PUT HTTPS request to the /VESPEmailSettings URL. For more information, see (PUT) /VESPEmailSettings.

    Save Library Folders

    To save SharePoint library folders, the request body must contain the save action:

    {

     "save": null

    }

    The request command will place library folders to a temporary folder on the Veeam Backup for Microsoft Office 365 server. After that, library folders will be transferred as application/octet-stream media to the client. To download, read or perform other actions with the octet-stream, use features of programming languages.

    (POST) /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Folders/Action Tip:

    You can use Swagger UI to download library folders from the stream by clicking Download action link in the response body.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the request body message for the requests with the export and save actions: application/octet-stream.

    The media type and syntax of the request body message for the requests with the restore and send actions: null.

    Response Body

    None.

    Example 1

    The following request restores SharePoint folders.

    Request:

    POST https://support.east.local:4443/v3/RestoreSessions/9de1aad8-b932-4083-b58a-edac38c35533/Organization/Sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/Folders/Action

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "restoreTo" :

     {

      "Folders" :

      [

        {

       "type": "ListFolder",

       "id": "1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898",

       "name": "AB922B82-8406-4E49-B17B-9057BDF09503",

       "createdBy": "System Account",

       "creationTime": "2017-04-16T08:06:36",

       "modifiedBy": "System Account",

       "modificationTime": "2017-04-16T08:06:36",

       "_links": {

        "self": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898"

        },

        "folders": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders?parentId=1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898"

        },

        "list": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/lists/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc3"

        },

        "items": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/items?parentId=1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898"

        }

       }

      },

     

       {

       "type": "ListFolder",

       "id": "1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc30b8e1466-e830-4199-b7c3-a09d1b0c6ca4",

       "name": "FEB96200-6E92-41DB-856B-E8702BCDF33A",

       "createdBy": "System Account",

       "creationTime": "2017-04-16T08:06:36",

       "modifiedBy": "System Account",

       "modificationTime": "2017-04-16T08:06:36",

       "_links": {

        "self": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc30b8e1466-e830-4199-b7c3-a09d1b0c6ca4"

        },

        "folders": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders?parentId=1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc30b8e1466-e830-4199-b7c3-a09d1b0c6ca4"

        },

        "list": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/lists/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc3"

        },

        "items": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/items?parentId=1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc30b8e1466-e830-4199-b7c3-a09d1b0c6ca4"

        }

       }

      }

      ],

      "list" : "exampleList",

      "username" : "admin",

      "userpassword" : "password",

      "RestorePermissions" : true,

      "DocumentVersion" : "last",

      "DocumentLastVersionAction" : "Merge"

     }

    }

     

    Response:

    200 OK

    Example 2

    The following request saves SharePoint folders.

    Request:

    POST https://support.east.local:4443/v3/RestoreSessions/9de1aad8-b932-4083-b58a-edac38c35533/Organization/Sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/Folders/Action

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "save" :

     {

      "Folders" :

      [

        {

       "type": "ListFolder",

       "id": "1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898",

       "name": "AB922B82-8406-4E49-B17B-9057BDF09503",

       "createdBy": "System Account",

       "creationTime": "2017-04-16T08:06:36",

       "modifiedBy": "System Account",

       "modificationTime": "2017-04-16T08:06:36",

       "_links": {

        "self": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898"

        },

        "folders": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders?parentId=1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898"

        },

        "list": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/lists/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc3"

        },

        "items": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/items?parentId=1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898"

        }

       }

      },

     

       {

       "type": "ListFolder",

       "id": "1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc30b8e1466-e830-4199-b7c3-a09d1b0c6ca4",

       "name": "FEB96200-6E92-41DB-856B-E8702BCDF33A",

       "createdBy": "System Account",

       "creationTime": "2017-04-16T08:06:36",

       "modifiedBy": "System Account",

       "modificationTime": "2017-04-16T08:06:36",

       "_links": {

        "self": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc30b8e1466-e830-4199-b7c3-a09d1b0c6ca4"

        },

        "folders": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders?parentId=1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc30b8e1466-e830-4199-b7c3-a09d1b0c6ca4"

        },

        "list": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/lists/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc3"

        },

        "items": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/items?parentId=1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc30b8e1466-e830-4199-b7c3-a09d1b0c6ca4"

        }

       }

      }

      ]

     }

    }

     

    Response:

    200 OK

    Example 3

    The following request sends SharePoint folders.

    Request:

    POST https://support.east.local:4443/v3/RestoreSessions/9de1aad8-b932-4083-b58a-edac38c35533/Organization/Sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/Folders/Action

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "sendto" :

     {

      "from": "fromUser@example.com",

      "to" : "toUser@example.com",

      "subject" : "Send document",

      "text" : "Hello. It’s your document!",

      "folders" :

      [

        {

       "type": "ListFolder",

       "id": "1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898",

       "name": "AB922B82-8406-4E49-B17B-9057BDF09503",

       "createdBy": "System Account",

       "creationTime": "2017-04-16T08:06:36",

       "modifiedBy": "System Account",

       "modificationTime": "2017-04-16T08:06:36",

       "_links": {

        "self": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898"

        },

        "folders": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders?parentId=1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898"

        },

        "list": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/lists/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc3"

        },

        "items": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/items?parentId=1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898"

        }

       }

      },

     

       {

       "type": "ListFolder",

       "id": "1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc30b8e1466-e830-4199-b7c3-a09d1b0c6ca4",

       "name": "FEB96200-6E92-41DB-856B-E8702BCDF33A",

       "createdBy": "System Account",

       "creationTime": "2017-04-16T08:06:36",

       "modifiedBy": "System Account",

       "modificationTime": "2017-04-16T08:06:36",

       "_links": {

        "self": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc30b8e1466-e830-4199-b7c3-a09d1b0c6ca4"

        },

        "folders": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders?parentId=1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc30b8e1466-e830-4199-b7c3-a09d1b0c6ca4"

        },

        "list": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/lists/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc3"

        },

        "items": {

         "href": "https://support.north.local:4443/v3/restoresessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/items?parentId=1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc30b8e1466-e830-4199-b7c3-a09d1b0c6ca4"

        }

       }

      }

     

      ]

     }

    }

     

    Response:

    200 OK

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.