Syncplicity Using REST API

Creating a Connection with a new SyncPoint "folder"

{ "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"   

To learn more, click here.

{ "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

{ "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.

Example Response

 

3. Copy the URL from item:sva_authentication_uri in the response and paste this value 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. A response similar to the following will be displayed in the browser with the account that was used to login, if successful. 

 

5. This connection is now available for use in DryvIQ jobs.

 

 

 

 

DryvIQ Platform Version: 5.9.2
Release Date: December 17, 2024