Syncplicity (REST API)
Create a Syncplicity connection using the DryvIQ REST API.
Table of Contents
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.
- Create the initial Syncplicity connection in DryvIQ.
- 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"
}
]
}
- 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",
...
},
...
}
}
- This connection is now available for use in DryvIQ jobs.