Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Contact Us
  • Home
  • API, CLI, and SDK Documentation
  • REST API Documentation
  • Connections Using REST API
  • Platform Specific REST API Documentation
  • Syncplicity

Syncplicity (REST API)

Create a Syncplicity connection using the DryvIQ REST API.

Written by Andrea Harvey

Updated at April 29th, 2025

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Insights
    Prebuilt Insights Custom Insights
  • Content
  • Accounts
  • Activity Log
  • Content Scans
  • Migrations
    Migration Jobs Migration Reports Maps Flagged Items Migration Tools
  • Connections
    Supported Platform Connections Creating Connections Connection Maintenance Connection Pools
  • Entity Types
    DryvIQ Available Entity Types Custom Entity Types Entity Type Maintenance
  • Action Sets
    Creating Action Sets Action Sets Maintenance
  • Settings
    License Performance Notifications Extensions Entity Types Settings Display Settings Configuration
  • API, CLI, and SDK Documentation
    REST API Documentation Command-line Interface SDK Development
  • POC Offering
  • Release Notes
+ More

Table of Contents

Creating a Connection With a new SyncPoint "Folder" Creating a Connection With a new SyncPoint "SyncDrive" Creating an Admin Mode Connection Creating a Connection to a StorageVault

Creating a Connection With a new SyncPoint "Folder"

POST {{url}}v1/connections/
{
   "name": "{{Syncplicity connection name}}",
   "platform": {
       "id": "syncplicity"
   },
   "auth": {
       "client_id": "{{syncplicity application key}}",
        "app_token": "{{syncplicity applicaiton token}}"
       "client_secret": "{{syncplicity application secret}}",
        "delete_behavior": "permanent"
       "syncpoint_type": "folder",
   }
}

Creating a Connection With a new SyncPoint "SyncDrive"  

POST {{url}}v1/connections/
{
   "name": "{{Syncplicity connection name}}",
   "platform": {
       "id": "syncplicity"
   },
   "auth": {
       "client_id": "{{syncplicity application key}}",
        "app_token": "{{syncplicity applicaiton token}}"
       "client_secret": "{{syncplicity application secret}}",
        "delete_behavior": "permanent"
       "syncpoint_type": "syncdrive",
   }
}

Creating an Admin Mode Connection

POST {{url}}v1/connections/
{
   "name": "{{Syncplicity connection name}}",
   "platform": {
       "id": "syncplicity"
   },
   "auth": {
       "client_id": "{{syncplicity application key}}",
        "app_token": "{{syncplicity applicaiton token}}"
       "client_secret": "{{syncplicity application secret}}",
       "admin_mode": true
   }
}

Creating a Connection to a StorageVault

To create a DryvIQ Syncplicity connection to a StorageVault configured with Authentication for use in DryvIQ jobs requires a few additional steps, which are outlined below.

  1. Create the initial Syncplicity connection in DryvIQ.
  2. Obtain the StorageVault Authentication URL and Update the Syncplicity Connection.  Retrieve the storage endpoint authentication URL with the following request via browser, curl, Postman, or other tool.
GET {{url}}v1/connections/{{connection_id}}/syncplicity-storageendpoints?sva=1&fields=auth

Example Response

{
   "status": 200,
   "item": [
       {
           "id": "09ba2cb2-222e-44bc-b48b-fe4027a7a473",
           "name": "SVA",
           "uri": "https://my-sva-server.syncplicity.com",
           "sva_authentication_uri": "https://my-sva-server.com.syncplicity.com/v2/auth?machine_id=a222333a-0159-4049-b97d-520770f1f1ef&scheme=http%3A%2F%2Fmy-company-server%3A9090%2Fv1%2Fconnections%2Fcavd9325f8994491888888bf09ue0c83%2Fsyncplicity-sva%2F09ba2cb2-309e-44bc-b48b-fe4027a7a473%2F%3Fcallback_token%3DQcbB0lrf%252FM9whZRoh%252FXlEwXAAAAymLqtQzAAAVHmuKs%253D%26token%3D",
           "requires_sva": true,
           "has_token": true,
           "type": "storage_endpoint"
       }
   ]
}
  1. Copy the URL from item:sva_authentication_uri in the response and paste it into a browser window. Enter the appropriate credentials in the returned login prompt and submit the form. If successful, an authentication token will be granted, returned to the DryvIQ Manager, and saved to the connection specified in the previous step. If successful, a response similar to the following will be displayed in the browser with the account that was used to log in.
{
   "status": 200,
   "type": "connection",
   "connection": {
       "id": "cabd9125f8994491888888bf09de0c83",
       "name": "Syncplicity (https://api.syncplicity.com/)",
       "platform": {
           "id": "syncplicity",
           "name": "Syncplicity",
            ...
       },
       "account": {
           "name": "Jane Doe",
           "email": "jdoe@example.com",
            ...
        },
        ...
    }
}
  1. This connection is now available for use in DryvIQ jobs.
syncplicity api rest api connection syncpoint syncdrive

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Dropbox for Business (REST API)
  • Dropbox (REST API)
  • Dropbox for Business Teams Folders (REST API)

Copyright 2025 – DryvIQ, Inc.

Knowledge Base Software powered by Helpjuice

Expand