arrow-left

All pages
gitbookPowered by GitBook
1 of 20

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Others

Logging and Debugging

Learn about logging and debugging with regards to Windows file servers

The Windows agent has a collection of logfiles that can be useful for debugging issues. Our support team might also ask for them from time to time.

You can find the default location for the logs here:

C:\Users\%username%\AppData\Local\CouchdropCloudConnector

You can also jump directly to the local logs and configuration file within the settings (gear) within the Couchdrop agent.

Dropbox

Learn how to connect Couchdrop to Dropbox

hashtag
Introduction

Connecting to Dropbox is fast to set up and fully supported in Couchdrop. Couchdrop can connect to both Dropbox Personal and Dropbox Business accounts.

hashtag
Requirements

To connect to Dropbox in Couchdrop you will need:

  • A licensed Dropbox account

  • Access to an Admin account to connect to Couchdrop (if connecting to Dropbox Business)

hashtag
Configuration Steps

  1. Log in to Couchdrop and add a new storage connection

  2. Provide a name for the connection. This is how the Dropbox connection will appear in Couchdrop

  3. Select Dropbox Personal or Dropbox Team from the list of available connections

Windows / Mac File Server

Learn how to connect Couchdrop to a Windows or OSX File Server

hashtag
Introduction

Couchdrop supports Microsoft Windows and Apple OSX using a lightweight agent that is installed directly on the file server, another server, or on a virtual machine.

The agent uses a shared token for authentication and communicates with Couchdrop's infrastructure via secure HTTPS calls. The agent can be run in a standalone fashion or .

circle-info

Google Workspace

Learn how to connect Couchdrop to a Google Workspace account

hashtag
Introduction

Couchdrop can be connected to a Google Workspace by creating a service account, which Couchdrop can do for you automatically. Couchdrop works with both Personal Google Drive accounts and Google Workspace accounts.

circle-info

Running the Couchdrop Agent as a Service

Learn how to run the Couchdrop Agent as a Service for file server transfers.

The Couchdrop Agent (Couchdrop Cloud Connector) can be run as a Windows service.

Installing the agent as a service requires some understanding of how Windows services work and the service must be configured to run as the same user that is performing the configuration.

Before starting, make sure that you have installed the Couchdrop Cloud Connector by Make sure you have run and configured everything properly and check that it is working. We recommend closing the desktop configuration app and systray application before starting the service.

Next in a command line, open the Couchdrop Cloud Connector folder located under Program Files and run the following command.

Next, open the service manager:

Find the service for "Couchdrop Cloud Connector" and open it.

OneDrive

Learn how to connect Couchdrop to a OneDrive folder

hashtag
Introduction

Couchdrop can be connected to a OneDrive folder in a few simple steps. Couchdrop works with Personal OneDrive accounts and SharePoint Sites.

circle-info

To connect to SharePoint, see

Non-GUI Environments

Learn about connecting the Couchdrop agent in a Non-GUI environment

hashtag
Install the agent on your Workstation

First, you need to install and configure the Couchdrop agent (Couchdrop Cloud Connector) on your workstation.

You can for configuration instructions. Once you have installed and configured the agent, you need to copy the configuration.

Connect Storage

Learn about storage integrations in Couchdrop

The key difference between Couchdrop and other SFTP servers, is that Couchdrop works with your Cloud Storage instead of local hard disks. This means you can turn any storage platform, shared drive or server into a SFTP and MFT server in a matter of seconds.

Couchdrop is also not limited to one particular storage integration, rather you can mount hundreds of stores in Couchdrop and they appear as independent folders.

See for more info on folders in Couchdrop

hashtag

Amazon S3

Learn how to configure a connection to Amazon S3 with Couchdrop

hashtag
Introduction

Connecting Couchdrop to an Amazon S3 bucket is done using an IAM keyset. It can be completed in a few minutes if you have the right access in AWS.

hashtag

Egnyte

Learn how to connect Couchdrop to Egnyte

hashtag
Introduction

Connecting to Egnyte is fast to set up and fully supported in Couchdrop.

hashtag
Requirements

Azure Files

Learn how to configure a connection to Azure Files with Couchdrop

hashtag
Introduction

Connecting to Azure Files online is fast to set up and fully supported in Couchdrop.

hashtag
Requirements

SharePoint

Learn how to configure a connection to SharePoint with Couchdrop

hashtag
Introduction

Connecting to SharePoint online is fast to set up and fully supported in Couchdrop. Couchdrop uses the Microsoft Graph API, which is the recommended method for connecting to SharePoint and OneDrive.

There are two different authentication methods available with SharePoint Online, Delegate Access or Application Access. The Couchdrop team recommends you use the default Delegate Access method, as it's simpler to configure.

Box

Learn how to configure a connection to Box with Couchdrop

hashtag
Introduction

Connecting to Box is fast to set up and fully supported in Couchdrop.

hashtag
Requirements

Choose Authorize Now and grant access to Couchdrop.
  • Click Test Connection

  • Select a User or sub-folder in Dropbox (Optional)

  • Click Save Settings.

  • To connect to a personal Google Drive account, see Google Drive

    hashtag
    Requirements

    To connect to Google Workspace in Couchdrop you will need:

    • A licensed Google Workspace Account

    • A folder in Google Drive

    • Access to an Admin User account in Google Workspace

    hashtag
    Configuration Steps

    1. Log in to Couchdrop and add a new storage connection

    2. Select Google Workspace from the list of available connections

    3. Enter the email of an admin user and the domain of the Google Workspace Account you wish to connect to.

    4. Click Create Service Account. Couchdrop will create a service account and generate a Client ID.

    circle-exclamation

    To proceed, you'll need to Delegate Domain Wide Authority to Couchdrop using the Admin Console. If you are unsure how to do this, see Delegating Domain-Wide Authority in Google Workspace

    1. After granting Domain Wide Authority, click Test Connection

    2. Choose a user or subfolder in Google Drive from the folder selector to be used as the root in Couchdrop (Optional)

    3. Click Save Settings.

    Requirements

    To connect to Amazon S3 in Couchdrop you will need:

    • An S3 Bucket already configured

    • An AWS IAM Key

    • An AWS IAM Secret

    • The AWS region

    • The IAM role must have adequate access to S3 and the targeted bucket

    hashtag
    Configuration Steps

    1. Log in to Couchdrop and add a new storage connection

    2. Select Amazon S3 from the list of available connections

    3. Provide the details above

    4. Click Test Connection

    5. Select a subfolder or bucket in S3 from the browser

    6. Click Save Settings

    To connect to Egnyte in Couchdrop you will need:
    • A licensed Egnyte account

    • A folder in Google Drive

    • Your Egnyte Domain

    hashtag
    Configuration Steps

    1. Log in to Couchdrop and add a new storage connection

    2. Provide a name for the connection. This is how the Egnyte connection will appear in Couchdrop

    3. Select Egnyte from the list of available connections

    4. Type in your Egnyte domain without egnyte.com (yourdomain.egnyte.com)

    5. Choose Authorize Now. A window will open to grant access to Couchdrop. Click Allow Access.

    6. Click Test Connection in Couchdrop

    7. Select a user or sub-folder in Egnyte (Optional)

    8. Click Save Settings.

    To connect to Azure Files online in Couchdrop you will need:

    • Azure Account Name

    • Azure Secret Key

    • Azure Share Name

    To learn how to configure Azure - you can visit https://docs.microsoft.com/en-us/azure/storage/common/storage-account-managearrow-up-right

    hashtag
    Configuration Steps

    1. Log in to Couchdrop and add a new storage connection

    2. Select Azure Files from the list of available connections

    3. Provide your account name, secret and share name.

    4. Click Test Connection

    5. Choose a subfolder in Azure

    6. Click Save Settings

    circle-check

    For connecting with Delgate Access, you can follow our step-by-step video guide below.

    Configuring Delegate access involves a standard OAuth login, and Application Access requires creating a custom application in your Azure Domain.

    circle-info

    To use Application Access see Other Connectors

    hashtag
    Requirements

    To connect to SharePoint online in Couchdrop using Delegate Access you will need:

    • An account in SharePoint

    • The account needs to be licensed

    • The account has access to the sites you are wanting to connect to

    • You have the SharePoint domain/hostname on hand

    hashtag
    Configuration Steps

    1. Log in to Couchdrop and add a new storage connection

    2. Select SharePoint from the list of available connections and set the connection name

    3. Provide your SharePoint domain/hostname in the field required

    4. Click Connect to Sharepoint and authorize the connection through the popup window. You will be required to log in to SharePoint with your account

    5. Check that the status is connected successfully

    6. Choose a SharePoint Site, Document Library, User or Folder

    7. Click Save Settings

    To connect to Box in Couchdrop you will need:
    • A licensed Box account

    • Access as a Team Admin (if connecting to other Box users in the organization)

    hashtag
    Configuration Steps

    1. Log in to Couchdrop and add a new storage connection

    2. Provide a name for the connection. This is how the Box connection will appear in Couchdrop

    3. Select Box from the list of available connections

    4. Choose Authorize Now and grant access to Couchdrop. Check "As Team Admin" if you wish to connect to folders from other users in the organization

    5. Click Test Connection

    6. Select a user or sub-folder in Box (Optional)

    7. Click Save Settings.

    We do not recommend installing the agent directly on the target file server. If possible, use a VM and connect via mapped network drives.

    hashtag
    Requirements

    To connect a Windows / OSX file server to Couchdrop you will need:

    • Remote access via RDP to the file server or a suitable VM

    • To have an administrator account

    • A reliable internet connection

    • A minimum of 16GB and 2 cores on the host or virtual machine

    • To be running Windows 10 or above (for Windows Servers)

    For a full list of requirements, see Server Requirements.

    hashtag
    Configuration Steps

    1. Log in to Couchdrop and add a new integration, either from +New > Connect Integration or the Integrations sidebar

    2. Click to add a new integration or Storage connector (Cloud Folder)

    3. Select Windows/OSX Server from the list of available connections

    4. Name the connection and create a cloud folder for Couchdrop

    5. Copy the Agent Token and download the agent. This token is only viewable once so be sure to copy it before leaving the screen.

    6. Log in to the remote target file server as an administrator

    7. Install the agent and launch it

    8. Paste the Agent Token from Couchdrop and click Connect. After a few seconds, the status indicator should change to show that the server is connected to Couchdrop.

    9. Return to the Couchdrop interface, click Test and Save.

    as a service

    hashtag
    Requirements

    To connect a personal OneDrive folder in Couchdrop you will need:

    • A licensed OneDrive Account

    • A folder in OneDrive

    hashtag
    Configuration Steps

    1. Log in to Couchdrop and add a new storage connection

    2. Select OneDrive from the list of available connections

    3. Choose whether or not to connect as an Administrator User,

    4. Click Authorize Now. This will open a page to connect to Microsoft via OAuth. Click Accept.

    5. Click Test Connection

    6. Choose a subfolder in OneDrive from the folder selector (Optional)

    7. Click Save Settings

    SharePoint

    Adjust the Log On configuration specifying the user account that you are logged in as the account to run the service under. This step is important as the agent configuration is stored under the user's profile. Without configuring the correct user, the service will not properly connect.

    Finally, you can start the service. Once it's running, you can reopen the Couchdrop Cloud Connector configuration application and it should show the service as Running in Background.

    .\couchdrop-cloud-connector-service.exe install
    services.msc
    following the steps outlined here
    . arrow-up-right
    On your workstation, browse to the folder

    Copy configuration.conf to a location you can access on the new server and also copy the Couchdrop Cloud Connector installer. Now you can uninstall the Agent from your workstation.

    hashtag
    Set up the agent on the Server

    On the server, you will need to open the command prompt as an administrator. Once you have done that, you will need to locate where you copied your installer and configuration.conf file on the server.

    Below is an example command of how to install silently, but your path may vary on your location.

    Once this is complete, you need to apply the configuration to the server. To do this, copy your configuration.conf.

    On the server, you will need to browse to this location. You may need to create the CouchdropCloudConnector folder under your Appdata\Local as the agent has not run yet.

    Now, we need to set up the agent as a service. Follow the article here for instructions on how to do that. Be aware you don't need to install the agent again. You can go to the area of the article where it tells you to run the following command.

    Once you have completed installing the agent as a service and the service is running, you can check your Couchdrop Cloud Connector configuration integration in Couchdrop and see if it shows a successful connection.

    follow the article here
    C:\Users\%username%\AppData\Local\CouchdropCloudConnector
    C:\Couchdrop\couchdrop-cloud-connector-installer.msi /quiet
    C:\Users\%username%\AppData\Local\CouchdropCloudConnector
    .\couchdrop-cloud-connector-service.exe install
    Connecting External Storage

    To connect to over 30 different cloud platforms of a server the process is simple. You will of course need credentials or an API keyset for the storage you want to connect, but that aside, the process is simple.

    hashtag
    Step 1: Create new Connection

    From the Browser or Storage Admin, click Add Storage Integration. This will pop open a modal window with some options.

    hashtag
    Step 2: Choose a new folder name

    Storage connections appear as folders in Couchdrop. So a crucial step in this process is to choose a folder name and location. Couchdrop supports nestling storage connections as well.

    hashtag
    Step 3: Choose a connection type and configure it

    Next up - choose a connection type. At this stage, you will be redirected to the configuration panel to manage this connection.

    For detailed information, see the child articles here or reach out to support.

    hashtag
    Common Storage Integrations

    Couchdrop supports over 30 different storage platforms. The most common ones are well documented.

    Virtual Folders

    Delegating Domain-Wide Authority in Google Workspace

    Walkthrough of how to delegate Domain-Wide Authority in Google Workspace to connect Couchdrop to a Google Workspace account

    hashtag
    Delegating Domain-Wide Authority

    Learn how to connect Google Workspace to Couchdrop with a Client ID and domain-wide delegation

    hashtag
    Introduction

    To connect a Google Workspace account to Couchdrop you need to delegate domain-wide authority so Couchdrop can access your users and migrate them automatically.

    hashtag
    Requirements

    Delegating Domain-Wide Authority requires the following:

    • A Google Workspace Administrator Account to access the Admin Console

    • Familiarity with the Google Admin Console

    • Client ID for Google generated in Couchdrop when configuring a Google Workspace connection

    hashtag
    Configuration Steps

    1. for your Google Workspace domain.

    2. Select the Security tab. If you don't see Security, select Show More from the bottom of the menu list.

    3. Choose Access and data control and then API controls.

    1. Click Authorize. Test that the connection in Couchdrop is successful to complete your configuration.

    For more information on domain-wide delegation, see this Support article from Google:

    Azure Blob

    Couchdrop has comprehensive support for Azure Blob containers out of the box. This document outlines requirements, configuration steps and capabilities for using Azure Blob with Couchdrop.

    hashtag
    Overview

    Azure Blob is supported natively with Couchdrop. Couchdrop allows users of Azure Blob to upload and download files and Azure Blob customers can easily configure and manage secure access to Azure Blob files and folders for access and use via SFTP, FTP, Automations and Web Access with granular user management and controls through a user-friendly web interface.

    hashtag
    Requirements

    Configuring access to Azure Blob is a simple process in Couchdrop. Lets get you up and running - you will need.

    1. An active Couchdrop account

    2. An active Azure Storage Account.

    3. Access to create a Container (or use an existing one).

    hashtag
    Configuration Steps

    Step 1: Create an Azure Blob Container - or Use an existing container

    1. In the Azure Portal - Navigate to Storage accounts → select your storage account.

    2. In the left menu, click Containers.

    3. Click + Container, give it a name, and set access level to Private (recommended).

    Step 2. Generate Credentials for Azure

    Option A: Access Key (simple but broad permissions)

    1. In the storage account, go to Access keys.

    2. Copy the Storage account name and Key1.

    Option B: SAS Token (more secure / scoped)

    1. In the storage account, go to Shared access signature.

    2. Select:

      • Allowed services: Blob

    3. Connect Couchdrop to Azure

    1. Log in to your Couchdrop dashboard.

    2. Click + Create -> Connect to Storage -> choose Azure Blob.

    3. Enter the required details:

    You will now see your Azure blob container as a folder in Couchdrop.

    hashtag
    Frequently Asked Questions

    chevron-rightCan we configure multiple users with different access permissions for SFTP with Azure?hashtag

    Yes - Couchdrop supports configuring as many users as you need and each user can have different folder level access to Azure Blob.

    Along with comprehensive permissions - Couchdrop also supports extensive auditing on user activity.

    chevron-rightHow does Couchdrop connect to Azure Blob?hashtag

    Couchdrop uses the official REST api provided by Microsoft to connect with Azure - via the internet. Data is transferred securely using +TLS 1.2.

    chevron-rightDoes Couchdrop store data when integrating with Azure Blob?hashtag

    No - when uploading or download data via Couchdrop with Azure - data is not stored on Couchdrops infrastructure at rest. You can think of Couchdrop in this context as a bridge or pipe for your data.

    chevron-rightCan we use FTP or FTPs with Azure Blob?hashtag

    Yes - Couchdrop supports FTP and FTPs natively as well.

    hashtag
    Supported Features

    Couchdrop has comprehensive support for interacting with Files in Azure Blob

    Feature
    Supported in Couchdrop

    Google Drive

    Learn how to connect Couchdrop to a Google Drive folder

    hashtag
    Introduction

    Couchdrop can be connected to a Google Drive folder in a few simple steps. Couchdrop works with Personal Google Drive accounts and Google Workspaces.

    circle-info

    To connect to a Google Workspace tenant, see

    hashtag
    Requirements

    To connect to Google Drive online in Couchdrop you will need:

    • A licensed Google Drive Account

    • A folder in Google Drive

    hashtag
    Configuration Steps

    1. Log in to Couchdrop and add a new storage connection

    2. Select Google Drive Personal from the list of available connections

    3. Click Connect to Google.

    Server Requirements

    Learn about requirements for connecting Couchdrop to file servers

    The Windows / OSX Agent allows for connections to on-prem file servers running Microsoft Windows or macOS. This software is run as an executable and can also be run as a service.

    hashtag
    Server Requirements

    While connection requirements can vary depending on the types of transfers involved, we recommend the resources below.

    Proxy Configuration

    Learn about working with proxy configuration for file servers

    In networks where internet access is only allowed behind a proxy server some additional manual configuration is needed.

    hashtag
    Configuration steps

    circle-info

    Component
    Recommendation

    CPU

    4-8 VCPU Core

    Memory

    16GB

    Hard Disk Space

    32GB of free disk

    hashtag
    Supported Windows Versions

    Below are the current supported and tested versions of Microsoft Windows that the agent supports.

    Operating System
    Supported?

    Windows XP

    No

    Windows 10

    Yes

    Windows Server 2012 R2

    No

    Windows Server 2016

    Yes

    Windows Server 2019

    Yes

    Windows Server 2022

    Yes

    circle-info

    For help configuring the agent on servers that are not listed here, contact [email protected]envelope.

    hashtag
    Software Requirements

    You will need Microsoft .NET Framework 4.7.2 to open the agent.

    hashtag
    Network Requirements

    The speed of your transfers will be heavily dependant on your internal and external network capacity. We recommend having the highest available uplink speed, with 1GB uplink speed over fiber if possible when moving high volumes of data or files.

    If you are experiencing performance issues with the agent, we recommend running a speed test and ensuring you've chosen a data region that is close to the agent when applicable.

    hashtag
    Firewall Requirements

    The Couchdrop agent communicates with the Couchdrop control plane and APIs exclusively via HTTPS. This means that no additional ports are needed to be opened. However, if your organization has a proxy server or web filter, you may need to allow the following domains out.

    • fileio.couchdrop.io

    • api.couchdrop.io

    • *.couchdrop.io

    • 8.8.8.8, 8.8.4.4

    For more information, get in touch with support via [email protected]envelope

    SharePoint and OneDrive

    Learn how to configure Couchdrop to connect to SharePoint.

    Azure Files

    Learn how to connect Couchdrop to Azure files

    Amazon S3

    Learn how to connect Couchdrop to Amazon S3 or an S3 compatible storage provider

    External SFTP Connections

    Learn how to connect Couchdrop to an external SFTP server

    Google Drive

    Learn how to connect Couchdrop to Google Drive

    Box

    Learn how to connect Couchdrop to Box

    Click Test Connection
  • Choose a subfolder in Google Drive from the folder selector (Optional)

  • Click Save Settings

  • Google Workspace
    Connection details you’ll need:
    • Storage account name

    • Access key or a SAS token

    • Container name

    Allowed resource types: Container and Object
  • Allowed permissions: Read, Write, List, Delete (depending on Couchdrop use)

  • Set start and expiry date.

  • Click Generate SAS and copy the SAS token.

  • Couchdrop Folder (this is where Couchdrop will present the Azure bucket)

  • Storage Account Name

  • Container Name

  • Authentication Method:

    • If using Access Key → paste the key.

    • If using SAS Token → paste the full SAS URL or token.

  • Optionally choose a folder in Azure

  • Azure Access Controls

    Supported via static IP in Couchdrop

    Uploading Files

    Yes

    Downloading Files

    Yes

    Listing files and folders

    Yes

    Creating folders

    Yes

    Deleting folders

    Yes

    Deleting Files

    Yes

    In the Domain wide delegation section, choose MANAGE DOMAIN WIDE DELEGATION.

  • In the API clients section, click Add new. Paste the Client ID generated from Couchdrop into the Client ID field.

  • In the OAuth scopes (comma-delimited) field, paste the following:

  • Login to the admin console arrow-up-right
    https://support.google.com/a/answer/162106?hl=enarrow-up-right
    https://www.googleapis.com/auth/drive,https://www.googleapis.com/auth/drive.file, https://www.googleapis.com/auth/admin.directory.user, https://www.googleapis.com/auth/admin.directory.user.readonly, https://www.googleapis.com/auth/admin.directory.user.security
    For detailed configuration instructions, see
    1. Install and run the agent

    2. Set the token

    3. Stop the agent and then add the proxy configuration manually

    4. To add the proxy configuration, you will need to locate the Movebot configuration file, normally it's located in the directory, C:\Users\%username%\AppData\Local\CouchdropCloudConnector.

      Open the file with Notepad, or something similar, and you will find a JSON with a base config.

    5. Edit the "proxies" section, adding an HTTP and HTTPS proxy with the syntax below:

    1. Save the file, and start the agent again.

    circle-check

    You can also find proxy settings and shortcut links to logs & configuration files in the settings section (gear) within the Couchdrop agent.

    hashtag
    Proxy URL syntax examples:

    Type
    Format
    Example

    Simple, no username and password

    http://<ip>:<port>

    With username and password

    http://username:password@<ip>:<port>

    Socks

    socks://<ip>:<port>

    hashtag
    Debugging

    To debug connection issues, check the log files located in the same directory as the configuration files and feel free to contact support for help at [email protected]envelope.

    Windows / Mac File Server
    {
    ...
    "proxies": {
    "http": "", 
    "https": ""
    }, 
    ...
    }
    http://127.0.0.1:8080arrow-up-right
    http://proxyuser:[email protected]:8080arrow-up-right
    socks://127.0.0.1:8080arrow-up-right

    SharePoint - Restrictive Permissions (App Registration)

    This guide walks you through securely connecting SharePoint to Couchdrop using an application registered in Microsoft Entra, with access restricted to a specific site using the Sites.Selected permission.


    hashtag
    Prerequisites

    • Access to

    • Admin rights to register apps and grant tenant-wide permissions

    • Access to

    hashtag
    Steps

    The process has three main steps that will be explained in detail.

    1. Configuring an Application in Entra

    2. Granting Site permissions to the Application in Microsoft Graph Explorer

    3. Connecting to SharePoint in Couchdrop using the configured Application


    hashtag
    Configuring an Application in Entra

    hashtag
    1. Register a New Application

    1. Go to

    2. Navigate to App registrations → + New registration

    3. Enter a name (e.g., Couchdrop-SharePoint)


    hashtag
    2. Copy your new Client ID and Tenant ID

    After registration, you will be taken to a settings page for your new app. Copy the following from the Overview tab:

    • Application (client) ID

    • Directory (tenant) ID


    hashtag
    3. Create a Client Secret

    1. Go to Certificates & secrets

    2. Click + New client secret

    3. Provide a description (e.g., CouchdropSecret), select expiry, and click Add


    hashtag
    4. Assign API Permissions

    Microsoft Graph API

    1. Navigate to API permissions → + Add a permission

    2. Select Microsoft Graph → Application permissions

    3. Find and check Sites.Selected


    hashtag
    Granting site permissions to App via Microsoft Graph Explorer

    hashtag
    1. Retrieve the Site ID

    To find the SharePoint site's ID, open the following URL in your browser and replace elements in brackets with your tenant and Site information.

    Example:

    This will return an XML object containing the Site ID:


    2. Sign in to Graph Explorer

    1. Visit

    2. Sign in with your Microsoft account

    3. Click the user icon (top-right) → Consent to permissions


    3. Send Permission Grant Request (for a specific site)

    ENDPOINT

    BODY

    Replace:

    • {site_id} with the GUID you retrieved earlier

    • <APPLICATION_CLIENT_ID> with your app’s Client ID

    • <APPLICATION_DISPLAY_NAME> with your app name (e.g., Couchdrop-SharePoint

    Click Run Query. A successful response will return 201 Created.


    4. Send Permission Grant Request (root site)

    ENDPOINT

    BODY

    Replace:

    • <APPLICATION_CLIENT_ID> with your app’s Client ID

    • <APPLICATION_DISPLAY_NAME> with your app name (e.g., Couchdrop-SharePoint)

    Click Run Query. A successful response will return 201 Created.


    hashtag
    Connecting to SharePoint in Couchdrop using the configured Application

    1. Return to Couchdrop and choose to create a new SharePoint connector.

    2. Uncheck the option to use Delegated OAUTH Access to connect via Application Access.

    3. Complete the configuration using:

    • SharePoint Domain

    • Client ID

    • Directory (Tenant) ID

    4. You must then “Choose a folder” and manually specify the SharePoint subfolder path. This ensures Couchdrop connects to the exact SharePoint site you granted access to via Sites.Selected.

    hashtag
    Folder Path Syntax

    5. Click Test to verify that you have successfully assigned access. Select Add Integration to complete the process.

    Leave all other options as default, then click Register

    Copy the Value before leaving this screen (it won’t be shown again)

    Click Add permissions

  • Click the checkmark Grant admin consent for [Your Org]

  • Scroll down and grant Sites.FullControl.All to your user
    )
    Client Secret
    Microsoft Entra Admin Centerarrow-up-right
    Microsoft Graph Explorerarrow-up-right
    entra.microsoft.comarrow-up-right
    Graph Explorerarrow-up-right
    https://<tenant>.sharepoint.com/sites/<siteName>/_api/site/id
    https://couchdropdemo.sharepoint.com/sites/MySite/_api/site/id
    <d:Id xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns:georss="http://www.georss.org/georss" xmlns:gml="http://www.opengis.net/gml" m:type="Edm.Guid">29cf2814-a045-4b48-8b1b-6bd01f57d632</d:Id>
    POST https://graph.microsoft.com/v1.0/sites/{site_id}/permissions
    {
      "roles": ["write"],
      "grantedToIdentities": [
        {
          "application": {
            "id": "<APPLICATION_CLIENT_ID>",
            "displayName": "<APPLICATION_DISPLAY_NAME>"
          }
        }
      ]
    }
    POST https://graph.microsoft.com/v1.0/sites/root/permissions
    {
      "roles": ["write"],
      "grantedToIdentities": [
        {
          "application": {
            "id": "<APPLICATION_CLIENT_ID>",
            "displayName": "<APPLICATION_DISPLAY_NAME>"
          }
        }
      ]
    }
    /sharepointsite:/sites/<siteName>:/Documents/<optional-subfolder-path>