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.
Andrea Harvey
aharvey@dryviq.com
103
Article
Last Month
-95.15%
Connection Platform API Client Credentials
Published May 9th, 2025 by Andrea Harvey
Overview When creating certain connections, you can specify which API client credentials you want to use for the connection. These credentials are used to get an Access Token required to access your platform account. You should consult your system administrator about which platform credentials should be used for your connection. Use the System Defa
Supported Authentication Types
Published May 9th, 2025 by Andrea Harvey
Overview Each storage platform supports a specific authentication method. You must understand the authentication your platform uses so you can collect the proper information to add when creating the connection. OAuth2 Interactive (Web) Flow This authentication method requires you to log in to the platform using the proper account credentials and gr
Connection User Type
Published May 9th, 2025 by Andrea Harvey
Overview When creating certain connections in DryvIQ, you can specify the user type. This determines whether the connection connects as a standard user or an account administrator. Connect as a Standard User This option creates a connection that will access a specific user’s files and folders. It is the default user type option when creating a new c
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}}" } }
MPIP Classifier Extension
Published May 5th, 2025 by Andrea Harvey
Overview The MPIP Classifier extension allows DryvIQ to extract your Microsoft Purview Information Protection (MPIP) sensitivity labels. This requires you to register an application in your Microsoft Azure account to obtain the Application (Client) ID and Directory (Tenant) ID required to allow DryvIQ to access the security labels through the Micros
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
DryvIQ's Custom Match Type Entity Types
Published May 6th, 2025 by Andrea Harvey
Overview The custom entity types are built-in entity types DryvIQ created to identify specific file information. This means you don’t have to create entity types for the file properties you want to use in your scans. You can use one of the seven custom entity types. Refer to Uploading Samples to learn how to upload individual files for analysis agai
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
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
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
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
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
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
Has External Permissions (REST API Only)
Published May 7th, 2025 by Andrea Harvey
Overview The DryvIQ Platform supports creating custom entity types that detect external email domains in file permissions. These entity types must be created manually using the DryvIQ REST API (via Postman or a command line tool such as PowerShell). Creating the Entity Type Endpoint The REST endpoint for the call is {{url}}v1/entity_types?fields=al
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
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: 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
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
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
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
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
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
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
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
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
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_
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
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"
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
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": {
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
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
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
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
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
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
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
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
Reconnecting Connections
Published May 12th, 2025 by Andrea Harvey
Overview If connections become disconnected, you can reconnect them using the existing credentials (the credentials used to create the connections) or by adding new credentials. Reconnecting Using Existing Credentials Expand Manage in the left menu. Click Connections. Locate the disconnected connection in the Connections list. Click the ellipses (…
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
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"
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
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":
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
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
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
Deleting Action Sets
Published May 9th, 2025 by Andrea Harvey
Overview If an action set is not used in a content scan, you can remove it as needed. Once an action set is used in a content scan, it will be locked and unavailable for deletion. Deleting an Action Set You can delete an action set if you are not using it to keep your action set list clean. However, you cannot delete action sets assigned to scans.
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
Managing Entity Type Categories
Published May 6th, 2025 by Andrea Harvey
Overview Categories identify the type of data being detected. DryvIQ comes with the default categories. You can also create custom categories if one of the default categories doesn’t capture what your entity type will be identifying. Preinstalled entity types will be assigned a corresponding default category. All custom entity types you create defau
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
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
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
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
Allow Unsupported File Names to be Changed
Published May 28th, 2025 by Andrea Harvey
Overview This behavior controls whether DryvIQ can change the names of folders and files that don't comply with the destination platform’s rules for unsupported characters. By default, this behavior is turned on for the job. DryvIQ will rename a file or folder instead of flagging it for manual remediation and preventing it from being transferred. Yo
Allow Truncation
Published May 28th, 2025 by Andrea Harvey
Overview Each platform has limits for path and segment lengths. The truncation option determines how to handle paths and segments that exceed these limits. If disabled (the default option), an item with a path or segment length that exceeds the platform limits will not transfer and will be flagged for remediation. When enabled, DryvIQ will attempt t
Change Item Inspection Policy
Published May 28th, 2025 by Andrea Harvey
Overview The Item Inspection Policy enables 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 already existed on the destination prior to the initial transfer. This feature categorizes items
Convert Box Notes
Published May 28th, 2025 by Andrea Harvey
Overview The Allow Rendition setting determines how Box Notes transfer from Box to the destination platform. This setting is disabled by default. If left disabled, Box Notes will be transferred in JSON format. When this setting is enabled, Box Notes will be transferred to other platforms as DOCX files. Job Behavior The job will handle Box Notes in
Creating a Connection
Published May 9th, 2025 by Andrea Harvey
Overview DryvIQ is built on the concept of connections. Authenticated connections are accounts verified with the cloud-based or network-based platform when created. The connection can be made using a specific user account (typically an email address) and its corresponding password or, where supported, OAuth 2.0 authorization (where a token is genera
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
DryvIQ's Classification Entity Types
Published May 6th, 2025 by Andrea Harvey
Overview A classification entity type is a custom classification model plugged into the DryvIQ Platform. You can add an entity type to a policy to have the policy find the associated information, and you also have the option of uploading files against an entity type to see if the corresponding information appears in the file. (Refer to Uploading Sam
Zip Unsupported File Types
Published May 28th, 2025 by Andrea Harvey
Overview Enabling this job behavior allows DryvIQ to compress any file that is not supported on the destination into a .zip format before being transferred. This will be done instead of flagging the item for manual remediation and halting the file transfer. For example, if you attempt to transfer the file "db123.cmd" from a Network File Share to Sha
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
Preserve File Versioning Between Locations
Published May 28th, 2025 by Andrea Harvey
Overview Some platforms keep snapshots of every change made to files. Version preservation determines how file versions are handled in the transfer. When version preservation is enabled for a job (the default option), DryvIQ will attempt to preserve all or the specified number of versions of the files, if supported on both platforms. If version pres
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
Link Detection and Remediation
Published May 28th, 2025 by Andrea Harvey
Overview You can enable link detection and remediation when defining the job's behaviors during job creation. It runs for both simulation and transfer jobs, scanning files to identify any links within them. The Jobs report will display the link information if available for the job. Once all the job runs are complete, you can execute link remediation
Length Exceeds Function (REST API Only)
Published May 7th, 2025 by Andrea Harvey
Overview DryvIQ offers a custom entity type that tests string property length against a specified limit. The entity type must be created manually through DeyvIQ’s REST API (using Postman or a command line tool such as PowerShell). Creating the Entity Type Endpoint The REST endpoint for the call is {{url}}v1/entity_types?fields=all, where {{url}} sh
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
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
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
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
Deleting a Connection
Published May 12th, 2025 by Andrea Harvey
Overview You can delete a connection that is no longer needed so it doesn’t appear in the Connections list. This applies to connections with both a Connected and a Disconnected status. Follow the steps below to delete a connection. Deleting a connection associated with active content scans and migration jobs will cause them to fail. Therefore, you s
Viewing License Details
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
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
Searching for Connections
Published May 12th, 2025 by Andrea Harvey
Overview The Refine option allows you to search your connections. Typing in the Search field narrows the filter options. You can search based on term (name), status, or storage platform. Searching Connections by Term (Name) Expand the Manage section in the left menu. Click Connections. Click Refine. Click Term. Type the search term or connection nam
Testing Connections
Published May 12th, 2025 by Andrea Harvey
Testing a connection allows you to verify that DryvIQ can connect to the platform. This is the same connection test that runs when you create the connection. If there seem to be issues with content scans or migration jobs for a particular connection, you can test the connection to ensure it is successful. If a connection test fails, it may mean the
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
Understanding Category and Match Type
Published May 6th, 2025 by Andrea Harvey
Overview An entity type is what DryvIQ is detecting. The DryvIQ Platform comes with preinstalled entity types that cover a wide range of data, but you also have the option to create custom entity types. Entity types are assigned to a category that identifies the type of data being detected and a match type that identifies how the data is being detec
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
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
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
Intelligent Migration
Published May 19th, 2025 by Andrea Harvey
Overview Intelligent migration is a crucial step in planning an efficient migration. DryvIQ scans your locations and provides an analysis of your content. Based on that analysis, you can make informed decisions about what content needs to be moved and where it needs to be moved. DryvIQ then transfers the content you tag to the specified location. Yo
Understanding Job Type
Published May 19th, 2025 by Andrea Harvey
Overview The job type defines the kind of job and the actions the job will perform with the content. Five job types are available: basic transfer, folder mapping, user account mapping, network home drive mapping, and intelligent migration. A basic transfer job is the only job that moves content. The other job types create a parent job that automatic
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
Basic Transfer Job
Published May 19th, 2025 by Andrea Harvey
Overview A basic transfer job moves content between platforms. When you create folder mapping, user mapping, network home drive mapping, or intelligent migration jobs, the child jobs that are created for those jobs are individual transfer jobs. The Transfer Direction determines if the content is transferred in one direction (source to destination) o
Mapping Import CSV File Guidelines
Published May 13th, 2025 by Andrea Harvey
Overview Mapping and exclusion imports must be a comma-separated values (CSV) file and follow a specific format. Data fields are wrapped in double quotation marks ("Value 1", "Value 2", "Value 3") and separated with commas. Empty fields must be qualified with two double quotation marks ("") to be accepted ("Field 1 Value","", "Field 3 Value"). This
Assigning a Job Category
Published May 21st, 2025 by Andrea Harvey
Overview The category function allows for the logical grouping of jobs for reporting and filtering purposes. The category is optional and does not alter the job function in any way. DryvIQ comes with two default job categories: Maintenance: DryvIQ maintenance jobs only. This category allows you to view the report of background maintenance jobs and i
Source Items Job Policy
Published May 21st, 2025 by Andrea Harvey
Overview This policy specifies what you want to happen to the source content once it has been transferred to the destination. Keep the Items on the Source This option copies the content on the source to the destination and takes no further action against the source content when the job is complete. You would choose this option if users need to reta
New Items Job Policy
Published May 21st, 2025 by Andrea Harvey
Overview This job policy determines how DryvIQ should handle new items identified on the source during subsequent job runs. Transfer the New Items This option tells DryvIQ to transfer any new items identified on the source to the platform. This option is ideal for smaller jobs. For Intelligent Migration jobs, this is the only New Items policy avail
File Version Conflicts Job Policy
Published May 21st, 2025 by Andrea Harvey
Overview The File Version Conflicts job policy determines how DryvIQ will behave when a file version conflict is detected on the source or the destination. There are five options, but not every option applies depending on the transfer direction selected. Refer to the information below to understand how the different transfer types handle each versio
Deleted Items Job Policy
Published May 21st, 2025 by Andrea Harvey
Overview When a delete is detected on either the source or the destination, the Deleted Items Policy determines how DryvIQ will behave. Regardless of the policy selected, the transfer direction selected for the job affects how deleted items can be handled. Refer to the information below to understand how the different transfer types handle each Dele
Job Policies Available Through REST API
Published May 21st, 2025 by Andrea Harvey
The following job policies are unavailable in the user interface when creating a job. You can only apply these policies when creating a job using the DryvIQ REST API or the Scripting feature available when creating a migration job. Refer to the following pages for information about these additional job policies. Directory Item Limits (max_items_per_
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
Creating Block List Entity Types
Published May 6th, 2025 by Andrea Harvey
Overview A block list is a set of keywords you want to find in content. This match type provides 100% accuracy because the content is compared against the list. DryvIQ only adds content to the match list if it finds one of the terms in the content. This page explains each section of the entity type screen and how you use it to build your custom enti
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
Managing Keywords
Published May 6th, 2025 by Andrea Harvey
Overview The Keywords page allows you to manage the keywords assigned to the entity type. You access this page using the Manage keywords option for an entity type. Use the links below to learn more. Managing negative keywords for regular expression entity types is the same as managing other keywords. The same functionality and options are available
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
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
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
Creating Regular Expression Entity Types
Published May 6th, 2025 by Andrea Harvey
Overview A regular expression is a pattern used to identify text. It allows you to have very fine-grained control over what content DryvIQ detects. The pattern must be constructed according to regular expression standards. Multiple online resources are available to explain how to build a regular expression pattern. When creating an entity using a re
Uploading Samples
Published May 6th, 2025 by Andrea Harvey
Overview You can upload sample files to run against an entity type and see the results for that file. This can help you analyze a file manually and allows you to test an entity type to ensure you don’t need to add any additional configuration to get the best results. The file size limit for an upload is 50 MB. Uploading Files Click the ellipses (
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
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
Job Transfer Direction
Published May 19th, 2025 by Andrea Harvey
Overview DryvIQ uses jobs to perform specific actions between the source and destination platforms. Transfer type determines how content is transferred from the source to the destination. Some transfer types are set based on the transfer direction selected on the Job Type page, and other job transfer types are set using a combination of the selected
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
Editing Connection Pools
Published May 12th, 2025 by Andrea Harvey
Overview You can update connection pools to edit the name, add connections, or remove connections from the connection pool. When editing a connection pool, remember that a pool must contain at least two connections. Editing a Connection Pool Click Connections in the left menu. Click Connection pools. Click the ellipses (…) for the connection pool.
Viewing the Connections is a Connection Pool
Published May 12th, 2025 by Andrea Harvey
Overview You can view a list of connections in a connection pool as needed. This is useful if you need to troubleshoot a connection pool or if you want to view the pool connections to determine if you need to edit a connection, add additional connections, or remove connections. Viewing Connections Expand Manage in the left menu. Click Connections.
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
Searching Connection Pools
Published May 12th, 2025 by Andrea Harvey
Overview The Refine option allows you to search the connection pools based on a term. This narrows the list to only the connection pools that match your search criteria. Searching Connection Pools Expand Manage in the left menu. Click Connections. Click Connection pools. Click Refine on the top-left side of the page. Click Term. Type the searc
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
Creating Connection Pools
Published May 12th, 2025 by Andrea Harvey
Overview Several factors can limit the transfer speed when transferring data between a source and a destination. Most cloud providers have rate limitations that reduce the transfer rate, but if those limits are account-based and the platform supports impersonation, DryvIQ can create a pool of accounts that issue commands in a round-robin format acro
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
Creating Automatic User and Group Mappings
Published May 13th, 2025 by Andrea Harvey
Overview The first step in creating a user or group map is to specify the automatic mapping rules you want to use. DryvIQ will attempt to map users or groups from one platform to another using the rules you select when creating the map. Note that all options are flagged as optional; however, you must select at least one of the following options for
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
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
Deleting Connection Pools
Published May 12th, 2025 by Andrea Harvey
Overview You can delete a connection pool if you no longer want to use it. This deletes the connection pool only and does not affect the individual connections. Deleting a Connection Pool Expand Manage in the left menu. Click Connections. Click Connection pools. Click the ellipses (…) for the connection pool. Click Delete in the menu that displays
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
Creating an Action Set
Published May 8th, 2025 by Andrea Harvey
Overview Action sets allow you to create a group of actions to add to a content scan or apply to individual files. DryvIQ works through the actions in the action set, automating activities to minimize the need for manual intervention. For content scans set to run on recurring schedules, action sets ensure continuous action against your unstructured
Duplicating Entity Types
Published May 7th, 2025 by Andrea Harvey
Overview You can duplicate an existing regular expression or block list entity type and edit it to expedite creating additional entity types. However, the duplicate feature is unavailable for all other entity types. Duplicating Entity Types Expand the Manage section in the left navigation menu. Click Entity types. Locate the entity type you want to
Deleting Entity Types
Published May 6th, 2025 by Andrea Harvey
Overview You can delete any custom entity type you created if it is not assigned to a content scan. If an entity type is assigned to a content scan, you must remove it from the scan before you can delete it. Preinstalled entity types (identified by the lock icon) cannot be deleted. Deleting a custom Entity Type Expand the Manage section in the left
Searching for Entity Types
Published May 7th, 2025 by Andrea Harvey
Overview The Refine link opens a search menu you can use to filter the Entity Types list to narrow down which entity types display. Typing in the search field narrows the filter options. Search based on term, category, match type, or status. Searching for Entity Types Expand the Manage section in the left menu. Click Entity Types. Click Refine. Cl
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
DryvIQ Persistent Label Classifier FAQ
Published June 10th, 2025 by Andrea Harvey
Overview Below are some frequently asked questions about the DryvIQ Persistent Label Classifier. Expand a question to review the answer. Can DryvIQ Persistent Labels co-exist with Microsoft Purview Information Protection (MPIP) labels? Yes, the labels are handled separately and don’t interfere with each other on the DryvIQ Platform or the Microsoft
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
Platform Comparison
Published May 12th, 2025 by Andrea Harvey
Platforms all have unique features and limitations. DryvIQ’s transfer engine manages these differences between platforms and allows you to configure actions based on Job Policies and Behaviors. Utilize the Platform Comparison tool to see how your integration platforms may interact regarding features and limitations.
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
Deploying Extensions to the DryvIQ Platform
Published May 5th, 2025 by Andrea Harvey
Overview During development of this extension, it is recommended to build the extension using dotnet build, which will build your extension in the Debug configuration as well as copy the extension into the appropriate directory on your machine for DryvIQ to pick it up if you have a local copy that you can use to test live within the product. However
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
Understanding DryvIQ Actions
Published May 8th, 2025 by Andrea Harvey
Overview DryvIQ offers several actions you can take against your content. You can apply a single action or create a comprehensive workflow that can be used either in a content scan or manually applied to individual items. Learn about each item below. Apply Metadata This action allows you to add specific metadata to a file. It requires you to comple
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
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
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.
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
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
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
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
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
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
Migration Planner
Published May 12th, 2025 by Andrea Harvey
Overview At the beginning of a project, it is common to begin planning with questions like, "How long should I expect this to take?" The Migration Planner allows you to outline the basic assumptions of any integration, primarily around the initial content copy at the beginning of a migration or first synchronization. It uses basic assumptions to beg
Self-Service Migration Management
Published May 12th, 2025 by Andrea Harvey
Overview The Self-Service Migration Management feature is tool that allows migration administrators to monitor each migration wave separately and easily manage the jobs for the migration waves as needed. The jobs are grouped based on the category assigned to the job when it was created. If you have created 10 job categories, the page will have 10 se
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
Configuring Job Locations
Published May 21st, 2025 by Andrea Harvey
Overview The Locations page is where you will select the source connection and destination connection to use for the job. The source defines the current location of the content you wish to transfer; the destination defines where you would like to move your content. Other fields on this page display based on the job type selected and if the platform
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
Editing Action Sets
Published May 8th, 2025 by Andrea Harvey
Overview If an action set is not used in a content scan, you can edit it as needed. Once an action set is used in a content scan, it will be locked and unavailable for editing. Editing Action Sets Expand Manage in the left menu. Click Action Sets. Click Edit next to the action set. Edit the action set as needed. Click Save to save the action set e
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
Impersonation (Run as User)
Published May 21st, 2025 by Andrea Harvey
Overview Impersonation allows a site admin access to all the folders on the platform, including those that belong to other users. A job can be set up using the username and password of the site admin to sync/migrate/copy files to or from a different user's account without ever having the username or password of that user. If a connection has been cr
Ignored Filter Reasons
Published May 16th, 2025 by Andrea Harvey
Overview DryvIQ tracks why items were categorized as ignored/skipped by policy as configured during job creation. These categories are used in the Job Validation Report. Ignored reasons are also available on the items grid by filtering the list by the “Ignored” status and selecting one of the ignored reason categories. Ignored Categories Reason Desc
Flagged Items FAQ
Published May 16th, 2025 by Andrea Harvey
Overview Items that the DryvIQ Platform could not transfer will be flagged for manual remediation. Items can be flagged for many reasons and, in some cases, still transferred to the destination platform. Each item is a package, consisting of the media itself, version history, author, sharing, and any other metadata. DryvIQ ensures all pieces of the
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
Migration Remediation Best Practices
Published May 15th, 2025 by Andrea Harvey
Overview Items are flagged for various reasons during a migration, and steps can be taken to ensure minimal flagged items throughout the various migration stages. This page provides DryvIQ’s best practices for remediating flagged items throughout the simulation and migration stages. Following these best practices is key to a successful migration. Be
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
Understanding Flagged Items
Published May 15th, 2025 by Andrea Harvey
Overview Each item is a package, consisting of the media itself, version history, author, sharing, and any other metadata. DryvIQ ensures all pieces of the item package are transferred to the destination to preserve data integrity. If DryvIQ can't transfer an item, the item is set to retry. By default, DryvIQ will attempt three times to reconcile it
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
Renaming a Connection
Published May 12th, 2025 by Andrea Harvey
Overview Once created, you can edit a connection name without affecting other settings. This is helpful if you have multiple connections to the same platform and need to add distinguishing information to help identify the connection. Renaming a Connection Expand Manage in the left menu. Click Connections. Locate the connection in the Connections li
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
Folder Mapping Job
Published May 19th, 2025 by Andrea Harvey
Overview Folder mapping jobs are ideal for migrations where you wish to control the transfer at a granular level without the effort of creating individual jobs. DryvIQ will automatically create a unique job for each folder in your hierarchy, inheriting configurations from the parent job. The folder mapping job can be controlled and manipulated like
Creating Custom Entity Types
Published May 6th, 2025 by Andrea Harvey
Overview You can create two kinds of entity types: regular expression and block list. The information required to create each entity type varies, so refer to the documentation for each type to ensure you understand each option. Creating a Custom Entity Type Expand the Manage section of the left navigation menu. Click Entity Types. Click Create entit
Creating Migration Reports
Published May 12th, 2025 by Andrea Harvey
Overview The migration reports provide several options for combining multiple jobs into a single report for review. Reports are generated by category, individually selected jobs, or by convention job parent (user job mapping, network home drive mapping, or folder mapping job types). Migration reports are separated into two categories (report types)
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
User Job Mapping Job
Published May 19th, 2025 by Andrea Harvey
Overview User Job Mapping jobs do not transfer any data. They are used to map user accounts on the source and destination platforms. The User Job Mapping job automatically generates child jobs based on the settings you’ve chosen for the job. These child jobs perform all the data transfers. You can select an account map for automatic user mapping rul
Viewing Migration Reports
Published May 12th, 2025 by Andrea Harvey
Overview The Reports dashboard will display a report widget for the report you created. The Reports page displays all the reports for transfer jobs, while the Simulations page tab displays all the reports for simulation jobs. Viewing Reports As the jobs run, the report data will be updated for review. Each report you create has a report widget on
Understanding Maps
Published May 19th, 2025 by Andrea Harvey
Overview A user account or group map explicitly associates users and groups to set authorship and permissions on transferred items. A source and destination connection are required to create a map, and they need to match the source and destination of the job that will be referencing the map. A map can be created before or during the job's creation,
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
Deleting Maps
Published May 13th, 2025 by Andrea Harvey
Overview If you created a map you no longer need, you can remove it. However, deleting maps from active jobs will cause issues. Deleting Maps Expand Scans in the left menu. Select Migrations. Click Maps. Select either User maps or Group maps depending on the map type. Find the map and click the ellipses (...) on the right side of the map tile. Clic
Understanding External Account Permissions for Microsoft
Published May 13th, 2025 by Andrea Harvey
Overview The External Permissions feature allows users to retain (migrate) permissions for external accounts between a DryvIQ-supported source platform and Microsoft SharePoint Online (SPO). People who need to see or work with content but do not have user accounts for your Microsoft SharePoint Online or Microsoft Office 365 environment are invited a
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 Exclusion Account and Group Mapping
Published May 13th, 2025 by Andrea Harvey
Overview An account or group map exclusion excludes an account or group from owner or permissions preservation. They can be defined during the map's creation or imported from a comma-separated values (CSV) file. If you receive an error when importing a CSV file, the file does not meet the expected format. You will need to edit the file before atte
Migrate Overview
Published May 12th, 2025 by Andrea Harvey
Overview The Overview provides a dashboard of what's been happening across all your migration content. The information does not include jobs in progress—only completed runs. The top section identifies the total number of jobs in the platform, the number of executed job runs, the total size of all analyzed content, and the total size of the content D
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": { "
Simulation Jobs
Published May 12th, 2025 by Andrea Harvey
Overview Simulation mode allows you to create a job with all desired configuration options and execute it as a dry run. In this mode, no data will transfer, no permissions will be set, and no changes will be made to the source or the destination. This can be useful in answering several questions about your content before running any jobs against you
Creating Explicit User and Group Mappings
Published May 13th, 2025 by Andrea Harvey
Overview As part of a user or group map, you can add explicit mappings from a user or group on the source to a user or group on the destination. These serve as exceptions to the automatic user or group mapping policies. The explicit mappings will be used to map users first, and any additional users or groups not in the mappings will be matched based
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": "
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
Network Home Drive Mapping Job
Published May 19th, 2025 by Andrea Harvey
Overview Network Home Drive Mapping jobs are ideal for migrations where you wish to control the transfer at a granular level without the effort of creating individual jobs. DryvIQ will automatically create a unique job for each home drive that can be matched to users between the source and destination connections. These child jobs inherit configurat
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
Persistent Label Classifier
Published May 5th, 2025 by Andrea Harvey
Overview The DryvIQ Persistent Label Classifier allows you to apply labels to files that become part of the file and persist with the file through version changes or even migration. The solution has two parts: The DryvIQ Persistent Label Classifier application: This desktop application is a separate service that runs outside of your DryvIQ Platform
DryvIQ CLI 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
Load More