Box (REST API)

Create a Box connection using the DryvIQ REST API.

On This Page

Creating a Connection Creating a Box Connection Using Connect As Standard User Creating a Box Connection Using Connect as Account Administrator Creating a Job Box Connection Created as Standard User (no Impersonation) Box Connection Created as Standard User With Impersonation Box Connection Created as an Account Administrator

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/connections/platforms/box/new?admin_mode=1

Creating a Job

Box Connection Created as Standard User (no Impersonation)

Connect as a Box user. The path relates to my source content.

POST {{url}}v1/jobs

{
   "name":"Simple Job",
   "kind": "transfer",
   "transfer": {
     "transfer_type": "copy",
       "source": {
           "connection": { "id": "{{Box_connection_AsStandardUser_sourceID}}" },
           "target": {
               "path": "/sourceFolder"
           }
       },
       "destination": {
           "connection": { "id": "{{OneDriveForBusiness_connection_destinationID}}" },
           "target": {
               "path": "/Documents/destinationFolder"
           }
       },
       "simulation_mode": false
   },
   "schedule": {
       "mode": "manual"
   },
   "stop_policy": {
       "on_success": 5,
       "on_failure": 5,
       "on_execute": 25
   },
   "category": {
     "name": "Report {Name}"
   }
}

Box Connection Created as Standard User With Impersonation

As a Box administrator, impersonate a user in the system where the path relates to their content. This requires administrator privileges to use the impersonation feature, such as administrator or co-administrator.

POST {{url}}v1/jobs

{
   "name":"Simple Job",
   "kind": "transfer",
   "transfer": {
     "transfer_type": "copy",
       "source": {
           "connection": { "id": "{{Box_connection_AsStandardUser_sourceID}}" },
            "impersonate_as": { "email": "user@company.com" },
           "target": {
               "path": "/sourceFolder"
           }
       },
       "destination": {
           "connection": { "id": "{{OneDriveForBusiness_connection_destinationID}}" },
           "target": {
               "path": "/Documents/destinationFolder"
           }
       },
       "simulation_mode": false
   },
   "schedule": {
       "mode": "manual"
   },
   "stop_policy": {
       "on_success": 5,
       "on_failure": 5,
       "on_execute": 25
   },
   "category": {
     "name": "Report {Name}"
   }
}

Box Connection Created as an Account Administrator

Connect as an account administrator. The path must include the user whose content you are transferring. If impersonation is used for this scenario, permissions will be ignored.

POST {{url}}v1/jobs

{
   "name":"Simple Job",
   "kind": "transfer",
   "transfer": {
     "transfer_type": "copy",
       "source": {
           "connection": { "id": "{{Box_connection_AsAdmin_sourceID}}" },
           "target": {
               "path": "/user@company.com/sourceFolder"
           }
       },
       "destination": {
           "connection": { "id": "{{OneDriveForBusiness_connection_destinationID}}" },
           "target": {
               "path": "/Documents/destinationFolder"
           }
       },
       "simulation_mode": false
   },
   "schedule": {
       "mode": "manual"
   },
   "stop_policy": {
       "on_success": 5,
       "on_failure": 5,
       "on_execute": 25
   },
   "category": {
     "name": "Report {Name}"
   }
}