Contact Us

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

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

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

Microsoft SharePoint On-premises (REST API)

Create a Microsoft SharePoint on-premises connection using the DryvIQ REST API.

Written by Andrea Harvey

Updated at April 29th, 2025

Contact Us

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

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

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

Table of Contents

Creating a Basic Connection Create a Connection with Applicable Authorization Type Creating a Job

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 are experiencing connection issues with SharePoint, you may need to configure for NTLM authentication for the auth_type parameter.

POST {{url}}v1/connections/
{
 "name": "SharePoint 2016",
 "platform": {
   "id": "sharepoint"
 },
 "auth": {
   "uri":"http://url.com",
   "username":"USER",
   "password":"PASSWORD",
   "auth_type":"ntlm"    
 }
}

Creating a Job

The example below shows a simple job for a SharePoint connection created as a standard user without impersonation.

POST {{url}}v1/jobs
{
   "name":"Simple Job",
   "kind": "transfer",
   "transfer": {
     "transfer_type": "copy",
       "source": {
           "connection": { "id": "{{SharePoint_Connection_sourceID}}" },
           "target": {
               "path": "/sourceDocumentLibrary"
           }
       },
       "destination": {
           "connection": { "id": "{{Box_Connection_destinationID}}" },
           "target": {
               "path": "/destinationFolder"
           }
       },
       "simulation_mode": false
   },
   "schedule": {
       "mode": "manual"
   },
   "stop_policy": {
       "on_success": 5,
       "on_failure": 5,
       "on_execute": 25
   },
   "category": {
     "name": "Report {Name}"
   }
}

 

on-premises api rest api sharepoint connection

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Google Workspace (REST API)
  • Amazon S3 (REST API)
  • Google Drive

Copyright 2025 – DryvIQ, Inc.

Knowledge Base Software powered by Helpjuice

Expand