On This Page

Overview

SkySync can create connections to platforms that are in "read-only" mode, meaning that you will never be able to modify any content on the platform using that connection. This can be useful for adding additional guarantees that a particular platform will never be modified by SkySync during a migration.

Supported Platforms

All Connectors

REST API | JSON Configuration

Read-only connections cannot be configured globally; they must be enabled per connection. To enable read-only connections through the REST API, "readonly": true must be added when creating the connection. See the following examples.

NFS

POST {{url}}v1/connections
{
    "name": "\\\\{{NFS_NAME}}\\{{FOLDER}}",
    "platform": {
        "id": "nfs"
    },
    "auth": {
        "unc": "\\\\{{NFS_NAME}}\\{{FOLDER}}",
        "readonly": true
    }
}

OneDrive for Business

POST {{url}}v1/connections
{
  "name": "OneDrive for Business READ ONLY Connection",
  "platform": {
    "id": "onedrive-business"
  },
  "auth": {
    "uri":"https://{{domain}}-my.sharepoint.com/personal/{{user_name}}_onmicrosoft_com/",
    "username":"{{username}}@{{domain}}.onmicrosoft.com",
    "password":"{{password}}",
    "readonly": true
  }
}

Expected Error Response

If a job is executed with a read-only connector, the job will fail with the following error: "The operation cannot be performed because the connection is in read-only mode."