Box
Version
This integration utilizes the Box API v2.0.
Base URL
The base URL used for all Box API endpoints:https://api.box.com/2.0
Authentication & Authorization
The DataGrail Box integration connects using OAuth 2.0.
Scopes
The Box integration requires specific scopes that must be granted in order to function for a given capability.
| Scope | Access | Deletion |
|---|---|---|
Read all files and folders stored in Box | ✅ | ✅ |
Write all files and folders stored in Box | ✅ |
Endpoints Utilized
DataGrail uses the following endpoints to authorize and test the connection:
| Method | Endpoint | Purpose | Docs |
|---|---|---|---|
| POST | /users/me | Verify authentication | |
| GET | https://account.box.com/api/oauth2/authorize | Request authorization | |
| POST | https://api.box.com/oauth2/token | Get and refresh access token |
Limits
Limits in Box are calculated using the leaky
bucket algorithm. All requests that are made after rate limits have been
exceeded are throttled and an HTTP 429 Too Many Requests error is returned.
Requests succeed again after enough requests have emptied out of the bucket.
- DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
- DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).
Capabilities
Access
DataGrail's Box integration provides Synchronous Access capabilities for the following supported identifier category: Email.Data Interactions
For Access requests, DataGrail will take the following actions:
- Searches for files, folders, web links, and shared files across the user's content using the configured identifiers as a query filter.
Endpoints Utilized
Deletion
DataGrail's Box integration provides Synchronous Deletion capabilities for the following supported identifier category: Email.Data Interactions
For Deletion requests, DataGrail will take the following actions:
- Delete the file, folder, or web link that the deletion request's lineage points to.
- If Skip deletion of folders that are not empty is enabled and the folder still contains items, leave the folder in place and mark the deletion as complete.
- If Permanently delete items is enabled, purge the deleted item from the Box trash.
Endpoints Utilized
Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.