DryvIQ Knowledge Base

Google Drive

Published April 29th, 2025 by Andrea Harvey

Create a Connection The code below shows how to create a new connection using a REST API call. The GET request returns JSON with the OAuth2 target URL needed to finish the connection creation. Follow the given URL to complete the connection setup. GET {{url}}v1/connections/platforms/google-drive/new Creating a Connection with a Delete Policy Soft de

Dropbox for Business (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Connection The following GET will return a target URL. Use this URL to log in to your Dropbox for Business account, authenticate, and create the connection. Make sure you connect using an Administrator account. GET {{url}}v1/connections/platforms/dfb/new Creating a Connection Using Custom Credentials The following example shows how to cre

Dropbox (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Connection The following GET will return a target URL. Use this URL to log in to your Dropbox account and authenticate the connection. GET {{url}}v1/connections/platforms/dropbox/new Creating a Job The sample code below shows how to create a job for a Dropbox connection. POST {{url}}v1/jobs { "name":"Simple Job", "kind": "transfer", "tr

Google Workspace (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating Connection The sample code below shows how to create a Google Workspace connection that uses impersonation. Make sure the following fields are set accordingly. The id should be google-suite. The client_email should be the Google Workspace Admin Service Account. The subject should be the email for the user you would like to impersonate. POST

Google Shared Drives (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Connection The sample code below shows how to create a shared drives connection that uses impersonation. Ensure that the following fields are set correctly. The client_email should be the Google Workspace Admin Service Account. The subject should be the email for the user you would like to impersonate. POST {{url}}v1/connections { "name":

Network File System

Published April 29th, 2025 by Andrea Harvey

Creating a Connection POST {{url}}v1/connections/ { "name": "\\\\{{Your Machine Name}}\\{{Your NFS Directory or Folder}}", "platform": { "id": "nfs" }, "auth": { "unc": "\\\\{{Your Machine Name}}\\{{Your NFS Directory or Folder}}" } }

Connection Pools Using REST API

Published April 29th, 2025 by Andrea Harvey

Creating a Connection Pool Create the connections that should be in a connection pool. Keep track of connection IDs. Using one of the connection IDs from the previous step, create a connection pool using the REST API. PATCH {{url}}v1/connections/{{connection_id}}/pool { "name":"New Connection Pool Name" } The pool:id in the response to the abov

Egnyte

Published April 29th, 2025 by Andrea Harvey

Creating a Connection The following GET messages will return an Egnyte login link. Use this link to complete logging into your account and to grant DryvIQ access to it. Create a New Connection as a Standard User GET {{url}}v1/connections/platforms/egnyte/new Create a New Connection as an Account Administrator GET {{url}}v1/connections/platforms/egny

Microsoft Azure Blob (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Connection Create a basic connection using the example below. Replace the example values with the information relevant to your connection. POST {{url}}v1/connections/ { "name": "display name goes here", "platform": { "id": "azure-blob" }, "auth": { "client_secret": "this is the access key", "domain": "this is the account name", "conta

Citrix ShareFile My Files and Folders (REST API)

Published April 29th, 2025 by Andrea Harvey

The following GET request will return a ShareFile login link. Use this link to log in to your account and grant DryvIQ access to it. GET {{url}}v1/connections/platforms/sharefile/new

Performance Counter Metrics Using REST API

Published April 28th, 2025 by Andrea Harvey

Overview The v1/diagnostics/metrics REST endpoint exposes several performance counter values, which can help diagnose server health. The table below lists the available performance counters. Metric Description app.memory.usage Amount of memory DryvIQ is currently using in MB app.uptime The amount of time DryvIQ has been running in seconds app.versio

Autodesk BIM 360 (OAuth 2.0) (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Connection The following GET will return a target URL. Use this URL to log in to the Autodesk BIM 360 account to authenticate and create the connection. Make sure you connect using an Administrator account. GET {{url}}v1/connections/platforms/autodesk-bim360-oauth2/new Creating a Job The sample code below shows how to create a job for an

License Audit Using REST API

Published April 28th, 2025 by Andrea Harvey

GET License Usage Use the following GET to get your license details. GET {{url}}v1/licensing?usage=true GET Job Details/Audit Log An audit log can be downloaded using one of the following calls. GET v1/transfers/audits.csv GET {{url}}v1/transfers/{job}/audits.csv Audit Log for a Specific Job Use the "job", "jobs", "job_id", or "job_ids" parameter to

CLI: Templates

Published April 24th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Overview The CLI allows you to manage job templates, including listing, showing, creating, and deleting templates. In all examples, the authentication parameters are provided within the configuration file. For more information, see CLI: Authentication. List Templates Parameter Description Required De

Microsoft Teams (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Connection The following GET request will return a Microsoft login link. Use this link to complete logging into your account and creating the connection. GET {{url}}v1/connections/platforms/microsoft-teams-graph/new

Microsoft One Drive for Business GCC High (REST API)

Published April 29th, 2025 by Andrea Harvey

Transferring Content to SharePoint Online Shared Document Library PlatformType in Connection: office365 URI Pattern in Connection: https://company.sharepoint.com/[SiteNameWhereLibraryExists]/ Target/Path in Job: Connection Config: /[LibraryName] This configuration will transfer data to the destination at the library specified. Connection will take i

Citrix ShareFile Shared Folders (REST API)

Published April 29th, 2025 by Andrea Harvey

The following GET request will return a ShareFile login link. Use this link to complete logging into your account and to grant DryvIQ access to it. GET {{url}}v1/connections/platforms/sharefile-shared/new

Procore (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Connection The example below shows how to create a Procore connection using DryvIQ’s default application credentials. The GET message will return a login link. Use this link to complete logging into your account and grant DryvIQ access to it. GET {{url}}v1/connections/platforms/procore/new Creating a Job The sample code below shows how to

LDAP Account and Group Maps Using REST API

Published April 29th, 2025 by Andrea Harvey

Overview Lightweight Directory Access Protocol (LDAP) is an Internet protocol used to look up data from a server. Using REST API calls, you can create an account map that integrates with LDAP. You can also query DryvIQ to return the LDAP configuration being used for an account map. Test LDAP Connection Use the following call to test the LDAP Connect

Microsoft Office 365 GCC High (REST API)

Published April 29th, 2025 by Andrea Harvey

Transferring Content to SharePoint Online Shared Document Library PlatformType in Connection: office365 URI Pattern in Connection: https://company.sharepoint.com/[SiteNameWhereLibraryExists]/ Target/Path in Job: Connection Config: /[LibraryName] This configuration will transfer data to the destination at the library specified. Connection will take i

Amazon S3 (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Basic Amazon S3 Connection Create a basic Amazon S3 connection using the following information. POST {{url}}/v1/connections/ { "name": "amazon S3", "platform": { "id": "amazon-s3" }, "auth": { "client_id":"{{client_id}}", "client_secret":"{{client_secret}}" } } Creating a Job Configuration Example POST {{url}}v1/jobs { "name":"Simple Job"

Connection Management Using REST API

Published April 29th, 2025 by Andrea Harvey

List all Connections GET {{url}}v1/connections List Connection Features and Limitations List Connection Features Ensure you have an established connection before making the following call. GET {{url}}v1/connections/{{cloud_connection}}?include=features List Platform Features To list general supported features for a given platform, make the following

Microsoft Office 365 (REST API)

Published April 29th, 2025 by Andrea Harvey

Transferring Content to SharePoint Online Shared Document Library PlatformType in Connection: office365 URI Pattern in Connection: https://company.sharepoint.com/[SiteNameWhereLibraryExists]/ Target/Path in Job:Connection Config: /[LibraryName] This configuration will transfer data to the destination at the library specified. Connection will take it

Adding a Notification Recipient Using REST API

Published April 28th, 2025 by Andrea Harvey

Overview Adding email recipients allows you to set global notifications that will trigger email messages whenever a subscribed event occurs. Because the notifications set here are global, they are not linked to a user, so notifications are not restricted to user-defined accounts, jobs, etc. This means you can send notifications to a user who does no

Dropbox for Business Teams Folders (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Connection The following GET will return a target URL. Use this URL to log in to your Dropbox for Business account, authenticate, and create the connection. Make sure you connect using an Administrator account. GET {{url}}v1/connections/platforms/dfb-teams/new Creating a Connection Using Custom Credentials The following example shows how

Microsoft SharePoint On-premises (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Basic Connection Create a basic SharePoint connection at the following endpoint. GET {{url}}v1/connections/platforms/SharePoint/new Create a Connection with Applicable Authorization Type Verify your instance support forms. In rare instances, a misconfiguration in SharePoint on-premises can falsely report that Forms are supported. If you a

Installer, Application, and Job Logs Using REST API

Published April 28th, 2025 by Andrea Harvey

Installer Logs Installer logs are located in C:\Users\{{User}}\AppData\Local\Temp\bitrock_installer.txt. Application/System Logs The default location for the DryvIQ application logs is C:\ProgramData\SkySync\v4\Logs\Log.txt. Job Logs The default location for the DryvIQ job logs is C:\ProgramData\SkySync\v4\Logs\Log{{job_id}}.txt. In each job log, yo

Custom Insights Assets Components

Published March 4th, 2025 by Andrea Harvey

Overview Assets allow you to customize your dashboard with text and images. Adding Text Click the Text tile. Fields display for you to add text. Type the text you want to display in the Title field. Optionally, type the additional text you want to display in the Subtitle field. Select the text size from the list. The text updates in the preview f

Autodesk BIM 360 (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Connection Create a basic Autodesk connection using the sample POST below. Replace the “name” and “auth” values with the values that apply to your Autodesk connector. POST {{url}}v1/connections/ { "name": "display name goes here", "platform": { "id": "autodesk-bim360" }, "auth": { "client_id": "client ID", "client_secret": "client secret"

Single Sign-On (SSO)

Published April 14th, 2025 by Andrea Harvey

The DryvIQ Platform can be used with your existing Single Sign-On (SSO) providers. While DryvIQ does not provide SSO as part of our platform, we support SSO implementation in any Kubernetes environment through the identity and access management solutions used for our different deployment options. Please refer to the deployment options below to under

Documentum (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Connection A basic Documentum connection can be made using the example below. POST {{url}}v1/connections/ { "name": "display name goes here", "platform": { "id": "documentum" }, "auth": { "uri": "http://CMIS URL", "username": "username", "password": "password", "repository": "repository name", "item_type": "cmis:document", "secondary_

Configuring the SMTP Server Using REST API

Published April 28th, 2025 by Andrea Harvey

Overview Configuring the SMTP server determines the mail server and account that will be used to generate the global email notifications. Once you add the information, you can test the connection to ensure no additional settings need to be added for the notifications to work. DryvIQ uses MailKit, which includes a default server certificate validatio

Permission Level Transfer Report Using REST API

Published May 2nd, 2025 by Andrea Harvey

Overview When exporting the report using a REST API call, you can receive a link through the call or view the CSV data within the response. Get a Download Link The following request produces a response that contains an href link. Copy and paste the link into your browser to download the CSV file. GET {{url}}v1/transfers/permissions View the CSV in

OpenText Content Server

Published April 29th, 2025 by Andrea Harvey

Creating a Basic Connection Create a basic OpenText connection at the following endpoint. GET {{url}}v1/connections/platforms/opentext-cs/new Creating a Connection with Applicable Authorization Type POST {{url}}v1/connections/ { "name": "OpenText", "platform": { "id": "opentext-cs" }, "auth": { "uri":"http://url", "username":"USER", "password":"PASS

Sharing & Access Control

Published March 4th, 2025 by Andrea Harvey

Overview Sharing & Access Control provides insights into your shared content. The top of the page identifies the percentage of your content that is shared internally and externally. The number of files that make up each percentage is also displayed. The charts on the page display the sharing breakdown for different categories. All charts are int

Stale Data

Published March 4th, 2025 by Andrea Harvey

Overview The Stale Data page offers valuable insights into outdated data within your system. To determine stale data, DryvIQ utilizes a combination of factors, including the last touched date, the status of the owner (if supported by the platform), and the status of the creator. Additionally, you have the option to consider the status of any users w

Entity Types Sample Context Capture

Published April 10th, 2025 by Andrea Harvey

Overview The Sample Context Capture setting determines how results display when evaluating a sample upload file against an entity type. Showing the contextual capture allows you to evaluate the correctness of the match. However, this means sensitive data may be exposed. Review the settings and select the display option you prefer. Again, ensure you

Manage Custom Insights

Published March 4th, 2025 by Andrea Harvey

Overview The Custom Insights feature allows you to create tailor-made dashboards that report on the information relevant to your unique use cases. This allows you to get all your content insights within the DryvIQ Platform, eliminating the need to use additional third-party reporting applications. Creating a New Dashboard Select Manage Custom Insigh

Syncplicity (REST API)

Published April 29th, 2025 by Andrea Harvey

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_behav

Custom Insights Data Sources

Published March 4th, 2025 by Andrea Harvey

Overview Data sources determine what information is pulled and how it is grouped. Once a data source is created, it is assigned to a visualization on the dashboard. It’s important to understand what type of visualization you want to create when creating the data source so you understand how adding information to each section will affect the visualiz

Creating Jobs Using REST API

Published April 30th, 2025 by Andrea Harvey

This page provides a sample of the features commonly configured for a migration job. The documentation for all features configured below can be found on the corresponding documentation pages. POST {{url}}v1/jobs { "name":"Job: All Features", "kind": "transfer", "transfer": { "transfer_type": "copy", "audit_level": "trace", "batch_mode": "always", "c

Document Categories

Published February 24th, 2025 by Andrea Harvey

Overview The Document Categories section helps you understand the composition of your data to help you make decisions about what you need to do with the content. Statistics The top part of the page breaks down the content into known document types and unknown document types. The total file count that was classified and the percentage of the conte

Box (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Connection The following GET request will return a Box login link. Use this link to complete logging into your account and grant DryvIQ access to it. Creating a Box Connection Using Connect As Standard User GET {{url}}v1/connections/platforms/box/new Creating a Box Connection Using Connect as Account Administrator GET {{url}}v1/connection

Transfer Job Configuration Options Using REST API

Published April 30th, 2025 by Andrea Harvey

Usage To use the options listed below, you would need to add the option to the "transfer": { } block when creating/editing a job using the REST API. Each colon (:) indicates a nested property. For example, to use source:size_estimate:bytes, you should include it as: POST v1/jobs { "name": "test copy", "kind": "transfer", "transfer": {

Scheduling a Job Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview A job schedule allows you to control when the job runs. The schedule manages job runs for you, so you don't have to execute them manually. The schedule can be set to determine both how often a job runs and when a job should stop running (also called the job stop policy). You also have the option to edit schedules for jobs. When defining the

DryvIQ Platform POC Microsoft Azure Marketplace Offer

Published April 14th, 2025 by Andrea Harvey

Overview DryvIQ offers a DryvIQ Platform POC offer in the Azure Marketplace. Customers who want to use DryvIQ in their Microsoft Azure tenant can install the offer as part of their proof of concept (POC) to test the platform’s features and capabilities against their business use case(s). The DryvIQ POC costs $2,500 monthly and is limited to 2 TB (sc

Sending a Test Email Notification Using REST API

Published April 28th, 2025 by Andrea Harvey

Overview You can trigger a test email notification using the REST API to review what recipients will see when an email notification is delivered. Sending a test notification is not dependent on having configured a notification policy. Use the following JSON to configure your REST API message. Send a Test Notification This request will not persist; i

Selecting Scans

Published February 24th, 2025 by Andrea Harvey

You can choose to view the results for one or more scans using the Select scans option. Document Sets Document set scans are not available in the Select scans modal at this time. Empty List The Selected scans list may momentarily appear empty when the list refreshes as you add or remove scans. This is expected behavior. Selecting Scans Click

File Inventory

Published February 24th, 2025 by Andrea Harvey

Overview File Inventory is the default page when viewing Insights. It provides insights into the files and file formats identified by Discover. You can choose to view each chart based on file size or file count. All charts are interactive, so if you click on a section in any chart, you will be taken to the Results page, and the results will be fil

Creating Custom Platform Extensions

Published April 14th, 2025 by Andrea Harvey

Prerequisites .Net Core SDK .Net IDE of choice Access to the DryvIQ SDK packages Getting Started All of our tutorials will begin from the command line. This is the most portable way to work with the dotnet CLI and makes no assumptions about your operating system or IDE. To make it easy to create custom DryvIQ Platform extensions, we deliver a custom

Microsoft One Drive for Business (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Connection You will need to add the relevant connection information to the GET request. The following GET request will return a Microsoft login link. Use this link to complete logging into your account and grant DryvIQ access to it. GET {{url}}v1/connections/platforms/onedrive-business-graph/new?domain={{YOUR URL}}&name={{YOUR CONNECT

Creating Custom Connectors

Published April 14th, 2025 by Andrea Harvey

Prerequisites .NET Core SDK .NET IDE of choice Access to the DryvIQ SDK packages DryvIQ SDK custom project template Basic understanding of creating a DryvIQ Platform extension Getting Started The DryvIQ Platform allows users to connect to on-premise and cloud storage platforms and orchestrate the content contained within those platforms. To orchestr

Deploying Custom Platform Extensions

Published April 15th, 2025 by Andrea Harvey

Getting Started During the development of this custom connector, DryvIQ recommends building the project using dotnet build . This will build using the Debug configuration and copy the connector into the appropriate directory on your machine for DryvIQ to pick up (if you have a local copy that you can use to test live within the product). However, on

License

Published April 10th, 2025 by Andrea Harvey

Overview The License page allows you to review your license details. It provides information to help you understand how your license usage is calculated and how migration jobs and content scans affect it. Usage Overview This section displays what’s currently available for your license. In addition to identifying the number of activations used and th

Creating Custom Transfer Extensions

Published April 14th, 2025 by Andrea Harvey

Prerequisites .NET Core SDK .NET IDE of choice Access to the DryvIQ SDK packages DryvIQ SDK custom project template Basic understanding of creating a DryvIQ Platform extension Getting Started The DryvIQ Platform allows users to connect to on-premise and cloud storage platforms and orchestrate the content contained within those platforms. To orchestr

DryvIQ Command-line Interface for Migrations

Published April 15th, 2025 by Andrea Harvey

The CLI references SkySync. This is expected. Overview The command-line interface is a tool that enables the scripting of many tasks. Prerequisites Node.js version 14: https://nodejs.org/en/download/ (Node.js 12 is the lowest version DryvIQ supports.) Windows PowerShell 5.0 or later Installation of skysync-cli To install the CLI, type the foll

CLI: Bandwidth Throttling

Published April 15th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Overview Bandwidth throttling allows the user to limit how much upload or download bandwidth DryvIQ's jobs use. Throttling can be set up to take effect at certain times of day. Parameters Parameter Description upload u Sets the upload bandwidth throttling download d Sets the download bandwidth thrott

DryvIQ Platform SDK Development

Published April 14th, 2025 by Andrea Harvey

Contact Us Our SDK repository is not publicly available. Please contact us for more information. The SDK references SkySync. This is expected. Platform Extensions Overview The DryvIQ Platform allows users to connect to on-premise and cloud storage platforms and orchestrate the content contained within those platforms. Out of the box, this inclu

CLI: Audit Categories

Published April 15th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Audit Categories The authentication parameters are provided within the configuration file in all examples. See the CLI: Authentication for more information. List Audit Categories Parameter Description Required Default search, q Search text Optional offset Search offset Optional 0 limit Search pag

CLI: Diagnostics

Published April 17th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Overview Diagnostics allow you to list diagnostic metrics and enable traces to troubleshoot issues. The authentication parameters are provided within the configuration file in all examples. See the CLI: Authentication for more information. Diagnostic Metrics Parameter Description Required metric m Me

CLI: Global Parallel Writes

Published April 15th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Overview Parallel writes is a configurable feature relating to the number of Web service requests across an instance of DryvIQ, on a given node, that will operate in parallel. Parameters Viewing or setting the parallel writes is done using the following two parameters. Parameter Description requested

CLI: Job Schedulers

Published April 23rd, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Overview Job schedules determine when migration jobs run. You can manage the job schedules using the command-line interface. The authentication parameters are provided within the configuration file in all examples. See the CLI: Authentication for more information. List Job Schedulers Parameter Descri

CLI: Licensing

Published April 23rd, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Overview You can use the CLI to view your current license information, activate a new license, or refresh a license. In all examples, the authentication parameters are provided within the configuration file. For more information, see CLI: Authentication . Show an Active License This command shows th

CLI: Logging

Published April 23rd, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Overview The logging level determines the amount of information that is captured and included in the application logs. You would change the logging level if you want to capture specific information only to troubleshoot issues. Parameters Parameter Description level The logging level set. The default

CLI: Sessions

Published April 15th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Sessions The authentication parameters are provided within the configuration file in all examples. See the CLI: Authentication for more information. Get a Raw Access Token Command skysync-cli sessions token Example Result eyJhbGciOiJSUzI1NiIsImtpZCI6IldVV0FXSlVKS1hFNUU1RDdZUFFOTFlCU0dRNzg1NVJZWTJYVVJ

CLI: Authentication

Published April 15th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Authentication The CLI requires authentication information to be passed in with every command. There are two ways to provide this information: in-line with the command or within a file. Paramater Description Required Default server The DryvIQ server URI Optional http://localhost:9090/ username, user

Configuration Options

Published April 24th, 2025 by Andrea Harvey

Directories and configuration options reference SkySync. This is expected. Overview This page provides information about how to set global configurations for the DryvIQ platform. You configure variables in the database through the command-line interface or in the appSettings.json file. (The appSettings.json file is located in C:\Program Files\Sky

CLI: Configuration

Published April 16th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Overview Configurations are global settings that control how certain features in the DryvIQ Platform work. You configure variables in the database through the command-line interface or in the appSettings.json file. (The appSettings.json file is in C:\Program Files\SkySync\appSettings.json unless a di

CLI: Profiles

Published April 23rd, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. List Profiles Parameter Description Required Default search q Search text Optional offset Search offset Optional 0 limit Search page size Optional 20 List All Profiles Command skysync-cli profiles list Example Results ID Name 40387f13ad504f998074a8b47a48168c Profile 1 9d06d20692f0469ba74b556827a9df

CLI: Cluster

Published April 15th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Managing a DryvIQ Cluster The authentication parameters are provided within the configuration file in all examples. See the CLI: Authentication for more information. Download a Cluster Node Installation Package This command downloads an Installation Package for a Cluster Node. By default, the install

CLI: Reports

Published April 24th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Overview The CLI allows you to manage your migration reports. The authentication parameters are provided within the configuration file in all examples. See the CLI: Authentication for more information. Managing Transfer Reports Getting the list of transfer reports is the first step in managing your t

CLI: Concurrent Jobs

Published April 15th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Overview The concurrent jobs setting determines the number of transfers that will operate in parallel. The default number of concurrent jobs is 6; the maximum number of concurrent jobs is 20. It is important to note that increasing the number of concurrent jobs does not always equal faster/better tra

CLI: Connections

Published April 15th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Overview You can use the CLI to create and manage connections in the DryvIQ Platform. The authentication parameters are provided within the configuration file in all examples. See the CLI: Authentication for more information. List Connections Parameter Description Required Default platform p Storage

CLI: Job Categories

Published April 17th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Overview The CLI allows you to manage migration job categories. This includes retrieving a list of existing job categories, creating new categories, and deleting categories. The authentication parameters are provided within the configuration file in all examples. See CLI: Authentication for more in

CLI: Sample Scripts

Published April 15th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Overview The skysync-cli project contains PowerShell and Node example scripts at ~skysync-cli/samples. Below is a summary of the available scripts. Node This sample demonstrates how to natively use the client SDK in Node for the following steps: Obtain SkySyncClient object with the provided credentia

Filtering the Files & Folders Grid

Published February 24th, 2025 by Andrea Harvey

Overview Discover results can return thousands of files depending on the makeup of your content. Filters allow you to narrow the results to only items that meet specified criteria. The Filter pane displays all the available filters. You can open and close the pane by clicking Filter. Some of the available filters are automatically generated based on

Duplicate Name Policy Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview This policy determines what DryvIQ should do when it encounters duplicate content names. Option Behavior "duplicate_names": "rename" Rename duplicate content. The file name will be appended with (1) to indicate it is the renamed file. This is the default option. "duplicate_names": "warn" Log a warning for duplicate names. Ensure to confi

Initialization Policy Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview The Initialization Policy determines how the job will behave the first time it executes. Option Behavior "on_initialize": "none" Nothing is done prior to the first job execution. (This is the default.) "on_initialize": "purge_destination" All files and folders in the destination path of the job are deleted prior to starting the file transfe

Empty Container Policy Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview The Empty Container policy allows the user to control whether empty containers (folders) are included in the transfer. This includes folders with no content and/or folders with all content filtered out by specified filter criteria. Option Behavior "empty_containers": "skip" Do not transfer empty containers. "empty_containers": "create" Tr

Item Inspection Policy Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview The Item Inspection Policy allows you to control the level of tracking and reporting for content that exists on both the source and destination platforms, including content that has been configured to be excluded from transfer and content that existed on the destination before the initial transfer. This feature categorizes items for reports

Item Overwrite Policy Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview The Overwrite policy controls DryvIQ's behavior when it detects the same file name on the target platform. The overwrite policy applies only to files; if DryvIQ detects folders with the same name, it merges them. Options Behaviors "item_overwrite": "overwrite" This is the recommended and default setting. When overwrite policy is configur

Job Retention Policy Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview The Job Retention Policy allows the user to configure the deletion of old audit log entries from the database. The system job “Apply Job Retention Policies,” which runs every four hours, deletes the entries in the applicable job audit log. Global Configurations All settings can be set through the command line (--settingname=value) or throug

Large Item Policy Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview The Large Item policy determines DryvIQ's behavior when it encounters items that are too large to upload to a given platform. If you have content that may violate a platform's file size policy, DryvIQ recommends this policy. You can use the job filters to filter content by size. Options Behavior "large_item": "fail" Failed item will be r

Job Failure Policy Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview Failure policy controls the behavior when a job's execution encounters an error. Options Behavior "failure_policy": "continue" Log error in the audit log and continue execution. This is the default option. "failure_policy": "halt" Log error in the audit log and stop execution. Job JSON Example { "name":"Simple Transfer Job with Failure Pol

Box Tags and Microsoft SharePoint Enterprise Keywords Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview In Box, the Tags feature allows you to mark, sort, and easily search for related files. Once enabled, users will be able to filter and search for files based on shared tags. In SharePoint, the Enterprise Keywords feature allows you to add enterprise keywords to items on a SharePoint site to tag and create a folksonomy. DryvIQ can preserve t

Bulk Migration (Batch Mode) Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview Batch mode is an optimized way to upload a high volume of data using a special API provided by some platforms. Currently, Dropbox, Dropbox for Business, Microsoft Office 365, and Microsoft OneDrive for Business have support for this feature. When running in batch mode, instead of committing one file at a time, files are committed in batches

Estimate Job Progress by Content Size Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview The Estimate Content Size feature reports job progress during transfer. This option is defined in your job configuration within the source or destination (sync jobs only) connection. Options include: size_estimate:count size_estimate:bytes Job progress can be monitored using the following endpoint. GET {{url}}v1/jobs/{{job}}?fields=all Un

Lock Propagation Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview The lock propagation feature allows you to configure if the lock status for files on the source will transfer to the destination with the same setting, assuming the destination platform supports it. Options Behaviors ignore Lock status for files on the source will not propagate to the destination. mirror_lock Lock status for files on the s

Box Service Account (REST API)

Published April 29th, 2025 by Andrea Harvey

Creating a Connection to Access All Users (enterprise_id) Use the Enterprise ID to list content for all users on your connection root. Box Service Account connections require Administrator privileges to use the impersonation feature. Co-administrators do not have the required permissions to perform impersonation. POST {{url}}v1/connections/ { "name"

Rate Limit Speed Using REST API

Published April 30th, 2025 by Andrea Harvey

Parmeters Three parameters can be configured to define the minimum and maximum operations per second against a connection, and how quickly these rates increase when rate limit exceptions stop occurring. These parameters can be applied globally by platform or to individual connections. Options Behavior min_rate This is the minimum number of operation

Restricted Content Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview When creating a job through the REST API, you can use the restricted_content setting to determine how DryvIQ handles restricted content. You have the following four options. Options Behaviors convert Zip restricted content so that it can be transferred successfully. This is the default setting. This is the same as the Zip unsupported file

DryvIQ Platform Release Notes

Published February 24th, 2025 by Andrea Harvey

Version: 5.9.3 Release Date: February 6, 2025 DryvIQ Platform version 5.9.3 was available on February 6, 2025. This is a maintenance release that focuses on enhancements and bug fixes. Learn more about the release below. For detailed information about items, refer to the DryvIQ Platform Documentation Center . Important Upgrade Information If updat

Timestamp Preservation Using REST API

Published April 30th, 2025 by Andrea Harvey

Timestamp preservation will maintain the original time the content was created, as recorded on the source. The policy can be set with either "timestamps": true (the default setting) or "timestamps": false. Although DryvIQ will preserve timestamps when migrating content, the receiving platform may alter the timestamps DryvIQ provides. This may cause

Trust Mode (Optimize Data Upload) Using REST API

Published April 30th, 2025 by Andrea Harvey

Trust mode is an optimized way to upload data to the destination when DryvIQ knows that files with the same paths are identical on both the source and destination. When trust mode is enabled, DryvIQ matches files by name only and does not make additional calls to verify file sizes, dates, etc. The default Trust Policy is set to “trust_mode”: false.

Understanding Chart Messages

Published March 4th, 2025 by Andrea Harvey

Overview When an empty chart is displayed, DryvIQ will display various messages to identify what is causing the empty state. This will help you understand if the result is due to a missing data source, an incomplete data source that requires additional configuration, or filters that aren’t returning results. The messages help you understand what you

Metadata Mapping Using REST API

Published May 1st, 2025 by Andrea Harvey

Overview Use metadata mapping to associate a set of properties in a file whose values you would like to transfer between the source and destination. You provide a set of metadata properties between the source and destination. When a file is transferred from source to destination (or vice versa), its property values are also transferred based on the

Mapping Microsoft SharePoint Content Types Using REST API

Published May 1st, 2025 by Andrea Harvey

Overview SharePoint content types are a type of custom metadata that allows you to categorize files. DryvIQ supports mapping content types between the source and destination. Currently, content type mapping is only available through the DryvIQ REST API. Retrieving Content Type You can send a GET request through the REST API to retrieve the metadata

Mapping Microsoft SharePoint Managed Metadata Using REST API

Published May 1st, 2025 by Andrea Harvey

Overview Microsoft SharePoint products support managed metadata. When using DryvIQ to move content between SharePoint systems, you can map your managed metadata to ensure the information transfers. For more information about managed metadata, refer to Microsoft’s documentation for managed metadata in SharePoint. Retrieving Managed Metadata You can s

CLI: Jobs

Published April 24th, 2025 by Andrea Harvey

The CLI references “skysync.” This is expected. Overview The CLI allows you to manage migration jobs in your DryvIQ Platform. In all examples, the authentication parameters are provided within the configuration file. For more information, see CLI: Authentic ation. List Jobs Parameter Description Required Default kind Job type Optional search q

Starting and Pause Multiple Jobs Using REST API

Published May 1st, 2025 by Andrea Harvey

Overview DryvIQ supports starting and pausing multiple jobs at once. This feature also allows you to filter the full list of jobs by search criteria or start/pausing all jobs. The syntax for starting and pausing jobs is very similar. The filtering options outlined in the examples apply to both actions. By default, DryvIQ will run 6 jobs in paralle

Configuring Started/Paused Status Using REST API

Published May 1st, 2025 by Andrea Harvey

Overview DryvIQ supports creating jobs with a predefined “start” status through REST API configuration. You can create jobs with manual schedules that execute immediately or auto schedules that are paused until a user intervenes. Based on the chosen schedule method, DryvIQ offers two options for this setting: start and paused. Job JSON Example Start

Skip Destination Events Using REST API

Published May 1st, 2025 by Andrea Harvey

Overview The skip_destination_events job setting skips destination events for a job run. This setting is helpful for migrations to an empty destination platform where all destination events are known on the initial job run and are not needed for a delta job run. Therefore, you would enable this setting after the initial job run since additional dest

Custom Insights Components Data

Published March 4th, 2025 by Andrea Harvey

Overview The Components Data allows you to select how you want to visualize the data. You have the option of selecting a pie chart, bar chart, table, or a summary of the items. You can then further customize the visualization to your liking. Adding Components Click the tile that corresponds to the visualization you want to use. The Edit visualiz

Changing Display Mode

Published April 10th, 2025 by Andrea Harvey

By default, DryvIQ displays in light mode, indicated by the Sun icon on the top menu bar. You can click this icon to switch to dark mode, and the icon will change to a Moon icon. You can use these icons to switch between dark and light mode. Light Mode Icon Light Mode Display Dark Mode Icon Dark Mode Display

Errors on Pages

Published May 2nd, 2025 by Andrea Harvey

An error page will appear when something goes wrong. This can be due to an issue connecting to the Data Catalog, the system not functioning properly, or a file issue. When you see an error page, contact DryvIQ Customer Support using the technical support link on the page or by emailing support@drvyiq.com for assistance troubleshooting the issue. Mak

Viewing Files and Folders

Published February 24th, 2025 by Andrea Harvey

Overview The Results page displays the content identified by Discover. The page refreshes every minute to ensure the grid always displays what is in the catalog. The first column in the results will always be Item name and displays the file name. The total number of items and the size of the items displays above this column. The results grid dynamic

Dashboard Report Using REST API

Published May 1st, 2025 by Andrea Harvey

Overview The sample code in this section provides REST API calls for the same information available on the Dashboard. Total Number of Jobs and Total Runs GET {{url}}v1/reports/all/stats?fields=transfer_stats Value of Data Identified and Data Resolved Cumulative total of source bytes: GET {{url}}v1/transfers/stats/by_status Cumulative total of dest

Overview Report Using REST API

Published May 2nd, 2025 by Andrea Harvey

Job Information Details Review the detailed job information, including source, destination, schedule, and current status. GET {{url}}v1/jobs/{{job}}?fields=all Example Response { "status": 200, "type": "job", "job": { "transfer": { "source": { "event_position": "8727246012870289", "options": null, "connection": { "id": "2aeae932f53e430d9b96739b913af

Retry Limits Using REST API

Published May 2nd, 2025 by Andrea Harvey

Overview When issues occur during transfer, DryvIQ categorizes the issues based on the error and flags items for manual remediation. This allows you to identify areas for review easily. By default, DryvIQ will retry an item three times. You can change the retry limit for different error messages. Format { "name": "Zips File Errors", "description": "

Log Report Using REST API

Published May 2nd, 2025 by Andrea Harvey

Job Audit for all Transfers GET {{url}}v1/transfers/auditing Job Audit for all Jobs Showing Only Errors GET {{url}}v1/transfers/auditing?level=error Job Audit for a Job GET {{url}}v1/transfers/{{job}}/auditing?include=all Job Audit for a Job Showing Only Warnings GET {{url}}v1/transfers/{{job}}/auditing?level=warn Job Audit for a Job Showing Only Er

User Mappings Using REST API

Published May 2nd, 2025 by Andrea Harvey

Overview The "resolution" indicates how the permission was mapped, such as by exception mapping, account map, email, or external account. The “permissions" value indicates how many items are shared with the user. GET {{url}}v1/transfers/{job_id}/security_map?include=all Example Results ....... ........... }, "item": [ { "id": "54604b5d86a344ca8040f7

Flagged Items Using REST API

Published May 1st, 2025 by Andrea Harvey

List All Flagged Items Use this request to list all items with a flagged status for all jobs. After review, items can be set to retry or be ignored on subsequent job runs. GET {{url}}v1/transfers/items/flagged Set Single Item to Retry or Ignore When an item is flagged, you can reset its status to either “retry” or “ignore” on the next job run. Set F

Content Insights Using REST API

Published May 1st, 2025 by Andrea Harvey

File Type Breakdown View a breakdown of the content grouped into five content categories. GET {{url}}v1/transfers/{{job}}/stats/by_content_category File Attributes Breakdown Each chart is divided into the top five buckets, with the remaining items captured in the "other" or "older" bucket. To return the information in the corresponding charts, u

Configuring an SMTP Server

Published May 2nd, 2025 by Andrea Harvey

Overview Configuring the SMTP server determines the mail server and account that will generate the global email notifications. Once you add the information, you can test the connection to ensure no additional settings are needed. DryvIQ uses MailKit, which includes a default server certificate validation for a list of commonly used mail servers such

Statistics Using REST API

Published May 2nd, 2025 by Andrea Harvey

Overview The stats endpoint provides insight into your transferred content through various ways to break down your reports. The following REST API requests help you understand what your transferred content looks like. Statistics By Age (Modified Date) List job content by age/modified date based on the top 5 buckets, with the remaining items captured

Items Report Using REST API

Published May 1st, 2025 by Andrea Harvey

List all Items Use the following call to list all items for all jobs. GET {{url}}v1/transfers/items List all Items for a Job GET {{url}}v1/transfers/{{job}}/items?fields=all List all Files and Folders for a Job GET {{url}}v1/transfers/items?jobs={{job}}&fields=all List Items by Parent Folder For a given job, this call returns all items within a

Sharing Insights Using REST API

Published May 2nd, 2025 by Andrea Harvey

Get User Access Rules GET {{url}}v1/transfers/{{job_id/stats/by_sharing?field=user_access_rules Example Response { "status": 200, "item": { "user_access_rules": { "name": "Shared to users", "source": { "bytes": 14049, "files": 8, "folders": 13, "versions": 9, "storage": 15234 }, "destination": { "bytes": 14049, "files": 8, "folders": 13 }, "order":

Adding Email Recipients

Published May 2nd, 2025 by Andrea Harvey

Overview Adding email recipients allows you to set notifications that trigger email messages when a subscribed event occurs. Because the notifications set here are global, they are not linked to a user, so notifications are not restricted to user-defined accounts, jobs, etc. This means you can send notifications to a user who does not have a DryvIQ

DryvIQ Platform REST API Documentation

Published April 28th, 2025 by Andrea Harvey

REST API documentation is available with the DryvIQ application after installation. You can access it by navigating to one of the following URLs: {proxy_url}/api-docs {ip.address}:9090/api-docs Issues have been identified with the Invoke-RestMethod command in PowerShell version 5.1, which is included with Windows Server 2019 and 2022. It is advisabl

Parallel Writes Per Job Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview Parallel writes is a configurable feature that relates to the number of web service requests across an instance of DryvIQ on a given node, which will operate in parallel. However, it is essential to note that increasing the number of parallel writes does not always result in faster or better performance. There is a long list of concepts tha

Directory Item Limits Policy Using REST API

Published April 30th, 2025 by Andrea Harvey

Overview While all platforms do not impose limits on the number of items that can be stored in a single directory, their APIs may limit the number of items that can be downloaded or uploaded. This means that when DryvIQ attempts to download content from the source that exceeds the platform API limit, errors may start to occur. The DryvIQ Platform en

Parallel Writes

Published May 2nd, 2025 by Andrea Harvey

Overview Parallel writes is a configurable feature that affects the number of Web service requests that will operate in parallel across an instance of DryvIQ on a given node. It is important to note that increasing the number of parallel writes does not always equal faster or better transfer performance. A long list of concepts must be taken into ac

Reconciliation Tools Using REST API

Published May 2nd, 2025 by Andrea Harvey

Overview This page outlines REST API calls you can use to help reconcile a job. Verify all Requested Features for a Job When creating your job using JSON, a wide variety of features may have been used. To verify that all were implemented as intended. We recommend verifying this by performing a Job Details call: Create your JSON with the desired feat

Creating a Job Report Using REST API

Published May 1st, 2025 by Andrea Harvey

Creating a Job With Category A category for your job is defined outside the transfer block in your JSON, in the section for schedule or job stop policy. The category name is a user-defined string. Any unique string will be recognized as a new category, and the job_category_id will be generated. }, "schedule": { "mode": "manual" }, "stop_policy": { "

Bandwidth Throttling

Published May 2nd, 2025 by Andrea Harvey

Overview Bandwidth throttling allows you to limit the upload or download bandwidth DryvIQ's migration jobs use. You can set throttling to take effect on certain days and at certain times. This is a global setting that affects all migration jobs. Jobs running when you set this parameter will not pick up the setting until the next job run. Clusters wi

Logging

Published May 2nd, 2025 by Andrea Harvey

Overview The logging level determines the amount of information captured and included in the application logs. You would change the logging level to capture specific information to troubleshoot issues. If you have multiple nodes, all nodes will be updated with the new setting. Logging Levels Level Description Trace This level includes all logging le

Job Validation Report Using REST API

Published May 1st, 2025 by Andrea Harvey

Overview Control the level of tracking and reporting for content that exists on both the source and destination platforms, including content that has been configured to be excluded from transfer and content that existed on the destination before the initial transfer. This feature categorizes items for reports on the Validation tab or within the job