API Changelog

2017-05-03 Auto-Generation of RSA Key Pairs and Exportable App Settings

You can now automatically generate your public and private RSA keys in the Box Developer Console and upload your public key to Box. Moreover, upon generating the RSA key pair, a configuration file is created and downloaded to your machine that contains all of your app’s settings (including your client_id, client_secret, enterprise_id, public_key_id, and your private key) that you need to authenticate your app to Box via JWT. You can use this file as a template to configure your app.

You can read more about this new feature in our announcement blog post.

2017-05-03 The New Box Developer Console is Now Generally Available

The new Box Developer Console is a complete design and functionality overhaul of the existing Box Developer Console and makes it easier than ever to create and manage applications on the Box Platform. You can check out the new Box Developer Console by logging into your developer account here.

You can read more about the new Box Developer Console in our announcement blog post.

2017-04-28 Increase in Metadata Template Limit for an Enterprise

Effective May 1, 2017, we will increase the limit on the number of metadata templates per enterprise from 50 to 500. You can read more about Metadata Templates in our documentation.

2017-04-28 New Configurable Permissions for Group Admin Role

We have introduced an expanded Group Admin role and introduced configurable permissions for Admins. Group Admins can manage other Group members and access reports. Admins can also configure the exact permissions a Group Admin has, such as the ability to run reports or add group members. Starting today, when creating a Group Admin via the API, you will now need to specify the exact permissions as a parameter. You can read more in our Membership Object documentation.

2017-03-30 New Limit for Applying Metadata Templates on a File or Folder

On April 3, 2017, we will enforce a limit of 100 metadata templates applied to a specific file and folder. If you try to apply more than 100 metadata templates to a specific file or folder, you will get a 403 error. Please make sure to have the appropriate error handling for exceeding this limit. For more details, please review the documentation for the Create Metadata on a File endpoint.

2017-03-13 Automatically Apply a Legal Hold Policy to New Files

The Create New Legal Hold Policy endpoint now supports automatically applying a legal hold policy to new files. To enable this feature when creating a legal hold policy, set the "is_ongoing" parameter to true. For more details, please review the documentation for this endpoint.

2017-03-02 File Name Change Available through Upload File Version Endpoint

The Upload File Version endpoint now supports changing a file's name when uploading a new file version

2017-02-22 Breaking Changes to the Preview SDK

If you are using a version of the Preview SDK prior to v0.101.0, please upgrade to v0.101.0 or higher. We will be making breaking changes to the underlying API the Preview SDK uses to support more functionality. We will release this change on March 22, 2017.

2017-02-08 Updates to the Box Java SDK

We have released a major update to the Box Java SDK to support all endpoints of the Box Content API. The latest version of the Box Java SDK supports several new endpoints, adds new features, and fixes several bugs that were identified by developers. The SDK is available on Github here.

The Box Java SDK now supports all endpoints, including:

  • Legal Hold Policies
  • Legal Hold Policy Assignment
  • Retention Policies
  • Metadata
  • Metadata Templates
  • Groups
  • Watermarking
  • Webhooks for File and Folder objects
  • Web Links
  • Collections
  • BoxGroupMembership for Paging
  • Device Pinning

The Box Java SDK also now supports features, including:

  • Token-based Authentication (also known as Transactional Authentication) to support Box View
  • The ability to pass a file's SHA1 when uploading new versions
  • Effective access for shared links
  • New Event Types in the BoxEvent class

You can access the SDK on Github here and read the release notes for the Box Java SDK v2.3.0 here.

2017-02-08 Updates to the Box Node.js SDK

We have released an update to the Box Node.js SDK to support all endpoints of the Box Content API. The SDK is available on Github here.

The Box Node.js SDK now supports all endpoints, including:

  • Legal Hold Policies
  • Retention Policies
  • Webhooks on File and Folder objects
  • Watermarking
  • Tasks
  • Users
  • Groups
    The latest release of the Box Node.js SDK is available on Github here.

2017-02-08 Updates to the Box .NET SDK and Support for .NET Core

we have released a major update to our .NET/C# SDK (also known as the Box Windows v2 SDK) to support all endpoints of the Box Content API. The latest version of the Box .NET/C# SDK supports several new endpoints, adds new features, and fixes several bugs that were identified by developers. Moreover, many developers in our community have requested support for .NET Core, which has also been added in this release. The SDK is available on Github here.

The new SDK supports new endpoints of the Box Content API, including:

  • File Versions
  • Collections
  • Webhooks for File and Folder Objects
  • Metadata
  • Watermarking
  • Groups
  • Users
  • Comments
  • Task Assignment
  • Events
  • Device Pinning
  • Weblinks
  • Shared Links
  • Collaborations
  • Retention Policies
  • Legal Hold Policies
  • Legal Hold Policy Assignment

The .NET/C# SDK also supports new features, including:
Token-based Authentication (also known as Transactional Authentication) to support Box View
Auto-pagination

You can access the SDK on Github here.

2017-02-07 Shared Link in Endpoint Responses

We modified the response of our endpoints to return the Shared Link URL when the caller is authorized to view the Shared Link. This affected endpoints such as Get File's Info , Get Folder's Info, and Shared Items. Only users with the following permission levels will be able to access a Shared Link URL:

  • Co-owner
  • Editor
  • Viewer Uploader
  • Viewer

You can read more about Box permission levels on our Community Site here.

2017-02-02 File Preview Client Events Available Through Box Preview SDK

We added support for file preview client events to our Preview SDK. This feature lets you listen for events associated with a file preview, such as when a user zooms into an image, navigates to the next page of a presentation, or pauses a video. The full list of client events supported for each file type is available here.

2017-02-02 New CONTENT_ACCESS Event Type

We have added a new event type to the user events API and the enterprise events API called CONTENT_ACCESS.

A CONTENT_ACCESS event fires every time a representation of a file is accessed. This may refer to a representation being accessed for preview, prefetching or offline access.

2017-01-10 Change to 'Move User's Folder' Name Structure

We have made a change to the naming structure of the folder that is automatically created when performing a Delete & Transfer on a user in the Box Admin Console or when performing a Move User's Folder API call using the Box Content API.

Previously, this auto-created folder would have the following name structure: "[Deleted User's Name]'s Files & Folders". To aid customers using this folder as part of automated deprovisioning processes, we've added the deleted user's email address to this folder's name. The folder now has the following name structure: "[Deleted User's Email Address] - [Deleted User's Name]'s Files and Folders".

2017-01-03 Markdown File Viewer

We introduced a new file viewer for Markdown files for file previews generated via the Get Embed Link endpoint of the Box Content API.

2016-12-12 File Collaborations API

We have expanded the Collaboration object in the Box Content API to support file-level collaborations, allowing you to set and apply permissions for users or groups to individual files. Previously, collaborations could only be applied to folder objects.

You can learn more about using collaborations for files and folders in our API documentation.

2016-12-05 Improved File Viewers for Text, Code, and CSV File Types

We have introduced new file viewers for text, code, and CSV file types for web browsers for file previews generated via the Get Embed Link endpoint of the Box Content API. These new viewers dramatically improve the readability and overall appearance of these file types in an embedded viewing experience.

Text Files

Text file preview

Text file preview

Code Files

CSV Files

2016-11-14 Changes to the User Events API

We've added six new event types for the user events API under the "changes" stream type:

  • COLLAB_ADD_COLLABORATOR
  • COLLAB_ROLE_CHANGE
  • COLLAB_INVITE_COLLABORATOR
  • COLLAB_REMOVE_COLLABORATOR
  • GROUP_ADD_USER
  • GROUP_REMOVE_USER

These events are accessible under the "all" stream type and under the "changes" stream type for the user events API.

2016-11-10 Watermarking API

The Box Watermarking API is now generally available. Using the Box Watermarking API, you can apply a semi-transparent overlay to a rendering of a file displayed in your app's user experience to indicate that a file contains sensitive or privileged information.

The watermark displays a current viewer’s email address or user ID (depending on the type of user account and whether or not the viewer is logged in), as well as the time of access over a file’s contents. Watermarks can be applied to files, including text-based documents, presentations, and images, as well as applied to folders where a watermark overlay would be applied to all the files contained in that folder.

The Box Watermarking API is available to all Developer, Enterprise, and Elite Box Plans. The Box Watermarking API can be used with either Box Managed Users or App Users.

For more information, please see our blog post and API documentation.

2016-10-27 New Event Triggers for Webhooks v2

We added six new event triggers for webhooks v2:

  • FOLDER.TRASHED
  • COLLABORATION.CREATED
  • COLLABORATION.ACCEPTED
  • COLLABORATION.REJECTED
  • COLLABORATION.REMOVED
  • COLLABORATION.UPDATED

2016-10-14 Changes to the Enterprise Events API

In early November, auditing information will be returned in the "additional_details" JSON response object for the METADATA_INSTANCE_CREATE, METADATA_INSTANCE_UPDATE, and METADATA_INSTANCE_DELETE event types. This auditing information will include the operation type, the field being targeted, and the resulting value of the targeted field. The operationParams field of the JSON response will conform to the JSON Patch structure (RFC6209).

{
    "chunk_size": 5,
    "next_stream_position": "1152922979616062927",
    "entries": [
        {
            "source": {
                "item_type": "file",
                "item_id": "5009686173",
                "item_name": "platform.jpg",
                "parent": {
                    "type": "folder",
                    "name": "Imagine",
                    "id": "998943173"
                }
            },
            "created_by": {
                "type": "user",
                "id": "20276369",
                "name": "Marge",
                "login": "Marge@some.email.com"
            },
            "created_at": "2016-09-27T13:45:22-07:00",
            "event_id": "f8d6ddcf-e88b-4501-ad3d-5391aefa06d9",
            "event_type": "METADATA_INSTANCE_CREATE",
            "ip_address": "Unknown IP",
            "type": "event",
            "session_id": null,
            "additional_details": {
                "metadata": {
                    "type": "coolStuff-ff11f2c2-d54b-454d-b0c4-a31854500806",
                    "operationParams": "[]"
                },
                "version_id": "122070245"
            }
        },
        {
            "source": {
                "item_type": "file",
                "item_id": "5009686173",
                "item_name": "platform.jpg",
                "parent": {
                    "type": "folder",
                    "name": "Imagine",
                    "id": "998943173"
                }
            },
            "created_by": {
                "type": "user",
                "id": "20276369",
                "name": "Marge",
                "login": "Marge@some.email.com"
            },
            "created_at": "2016-09-27T13:45:47-07:00",
            "event_id": "a6c6109c-a7e5-41c0-9ffa-93c55c6a7532",
            "event_type": "METADATA_INSTANCE_UPDATE",
            "ip_address": "Unknown IP",
            "type": "event",
            "session_id": null,
            "additional_details": {
                "metadata": {
                    "type": "coolStuff-ff11f2c2-d54b-454d-b0c4-a31854500806",
                    "operationParams": "[{\"op\":\"add\",\"path\":\"\\/name\",\"value\":\"Platform Shoe\"}]"
                },
                "version_id": "122070245"
            }
        },
        {
            "source": {
                "item_type": "file",
                "item_id": "5009686173",
                "item_name": "platform.jpg",
                "parent": {
                    "type": "folder",
                    "name": "Imagine",
                    "id": "998943173"
                }
            },
            "created_by": {
                "type": "user",
                "id": "20276369",
                "name": "Marge",
                "login": "Marge@some.email.com"
            },
            "created_at": "2016-09-27T13:46:28-07:00",
            "event_id": "89c94b9d-b397-4e39-98e2-51fde1fc335c",
            "event_type": "METADATA_INSTANCE_UPDATE",
            "ip_address": "Unknown IP",
            "type": "event",
            "session_id": null,
            "additional_details": {
                "metadata": {
                    "type": "coolStuff-ff11f2c2-d54b-454d-b0c4-a31854500806",
                    "operationParams": "[{\"op\":\"add\",\"path\":\"\\/coolDescription\",\"value\":\"Lace-ups\"}]"
                },
                "version_id": "122070245"
            }
        },
        {
            "source": {
                "item_type": "file",
                "item_id": "5009686173",
                "item_name": "platform.jpg",
                "parent": {
                    "type": "folder",
                    "name": "Imagine",
                    "id": "998943173"
                }
            },
            "created_by": {
                "type": "user",
                "id": "20276369",
                "name": "Marge",
                "login": "Marge@some.email.com"
            },
            "created_at": "2016-09-27T13:46:46-07:00",
            "event_id": "a4fd1514-db29-4754-861b-9f932bad6dcc",
            "event_type": "METADATA_INSTANCE_UPDATE",
            "ip_address": "Unknown IP",
            "type": "event",
            "session_id": null,
            "additional_details": {
                "metadata": {
                    "type": "coolStuff-ff11f2c2-d54b-454d-b0c4-a31854500806",
                    "operationParams": "[{\"op\":\"test\",\"path\":\"\\/name\",\"value\":\"Platform Shoe\"},{\"op\":\"replace\",\"path\":\"\\/name\",\"value\":\"Fashion Shoe\"}]"
                },
                "version_id": "122070245"
            }
        },
        {
            "source": {
                "item_type": "file",
                "item_id": "5009686173",
                "item_name": "platform.jpg",
                "parent": {
                    "type": "folder",
                    "name": "Imagine",
                    "id": "998943173"
                }
            },
            "created_by": {
                "type": "user",
                "id": "20276369",
                "name": "Marge",
                "login": "Marge@some.email.com"
            },
            "created_at": "2016-09-27T13:46:55-07:00",
            "event_id": "fa26b848-05a6-4e47-b0a4-f2a2d2603a05",
            "event_type": "METADATA_INSTANCE_DELETE",
            "ip_address": "Unknown IP",
            "type": "event",
            "session_id": null,
            "additional_details": {
                "metadata": {
                    "type": "coolStuff-ff11f2c2-d54b-454d-b0c4-a31854500806"
                },
                "version_id": "122070245"
            }
        }
    ]
}

2016-09-21 Changes to the Enterprise Events API

We added a size attribute in the enterprise events API for item-related events such as UPLOAD and DOWNLOAD events. The new attribute will be available within additional_details and represent the size of the item in bytes:

 {
      "source": {
        "item_type": "file",
        "item_id": "75012612274",
        "item_name": "sample.jpg",
        "parent": {
          "type": "folder",
          "name": "All Files",
          "id": "0"
        }
      },
      "created_by": {
        "type": "user",
        "id": "222853849",
        "name": "Joe Smith",
        "login": "jsmith@example.com"
      },
      "created_at": "2016-09-19T20:19:05-07:00",
      "event_id": "dbb79480-9c09-4c27-a0c7-5e530403129b",
      "event_type": "DOWNLOAD",
      "ip_address": "Unknown IP",
      "type": "event",
      "session_id": null,
      "additional_details": {
  "size": 629644,
        "shared_link_id": "r9cjcjnoqlds4d8lqj28hj8axivah72y",
        "ekm_id": "56847758-20e2-4538-aefb-9181313a0dcf",
        "version_id": "79419605034"
      }
    }

2016-09-16 Changes to the User Events API

In November, we'll be adding six new events for the user events API under the "changes" stream type:

  • COLLAB_ADD_COLLABORATOR
  • COLLAB_ROLE_CHANGE
  • COLLAB_INVITE_COLLABORATOR
  • COLLAB_REMOVE_COLLABORATOR
  • GROUP_ADD_USER
  • GROUP_REMOVE_USER

These events are currently accessible under the "all" stream type for the user events API, but in this new release, these events will also be accessible under the "changes" stream type.

2016-09-12 Annotations are Now Available in Public Beta

Annotations is a new beta feature that allows users to markup a file directly on the file preview. We offer two types of annotations: Highlights and point annotations. Annotations are available via the Get Embed Link endpoint. To enable annotations for specific previews in your app simply add the following parameter at the end of the URL generated by the Get Embed Link endpoint: "?showAnnotations=true".

2016-09-08 Webhooks v2 GA

Webhooks v2 are now generally available. The Webhooks v2 endpoint in the Box API defines GET, POST, PUT, and DELETE methods you can use to create webhooks, define the events that trigger notifications, set the URLs they communicate with, and remove them when they are no longer needed. Learn more here.

2016-09-08 Service Accounts

Service Accounts are a secure and powerful way to connect your apps to Box Platform. This is a type of Box account that represents a custom application within an enterprise instance of Box and allows that application to make server-side calls to the Box APIs. You can define the capabilities of each individual Service Account dynamically, setting permissions such as uploading and managing content, managing users and groups, accessing events, or using premium features like Box Governance to set retention policies or apply legal holds. Find out more details here.

2016-09-08 New Developer Console

We launched an overhaul to the user experience and functionality of the Box Developer Console. New features include a new UI, guided walkthroughs for configuring applications, easy access to support, and documentation and notifications. Click here to try the new experience.

2016-09-08 JavaScript Preview SDK

The Javascript Preview SDK allows developers to easily embed previews of Box files in a web application. The SDK fetches information about the file and its converted representations through the Box Content API, chooses the appropriate viewer for the file type, dynamically loads the static assets and file representations needed, and finally renders the preview client-side. The SDK also allows previews of multiple files to be loaded in the same container and exposes arrows to navigate between those files.

2016-08-19 Download Domain Split Now Live

The change to use separate subdomains for "boxcloud.com" download links is now live. With this change, any downloads from anonymous or free Box users will be served out of "public.boxcloud.com" while paid and enterprise customers will be served off of "dl.boxcloud.com".

2016-07-28 Legal Holds Endpoints Now GA as part of Box Governance

Legal Holds are now available as part of Box Governance. With Legal Holds, Governance customers can now preserve content in place to kick off the eDiscovery process in the face of litigation. It's easy to manage, helps limit liability, ties seamlessly in with retention schedules, and integrates with the best eDiscovery technologies to further protect corporate assets. Find out more details here.

2016-07-28 Webhooks v2 Now Live in Open Beta

Webhooks v2 are now available as an open beta. Webhooks v2 allows developers to programmatically monitor and trigger actions based on activity in Box all through the API. Learn more here.

2016-07-22 Annotations are Now Available in Beta

Annotations are now available in beta. Annotations allow users to add point-and-click comments or text highlights to a preview of a file obtained via the Get Embed Link of the Box API. Annotations are only available in file previews generated via the API and are not currently supported in the Box apps. For more information about the beta, please click here.

2016-07-14 The Box Node.js SDK is now available

The Box Node.js SDK is now available on Github and npm. The Box Node.js SDK is an officially supported SDK from Box, meaning we'll continue to update it as new features and capabilities become available via the Box APIs.

2016-07-14 Watermarking on File Previews via the Get Embed Link Endpoint

Watermarks will now display on file previews generated via the Get Embed Link endpoint of the API. Watermarks can be configured using the Box web app. Watermarks will only display for Box user accounts, not App Users.

For more information, please see our Watermarking Support Page.

2016-07-05 New Event Type for Standard User Events

Added GROUP_ADD_USER and GROUP_REMOVE_USER as standard user events that indicates a user has been added or removed from a group

2016-06-28 CORS Settings Now Available in the Developer Console

Developers can now enter a comma-separated list of origins that can make CORS request to the API in the Developer Console. Previously, developers needed to contact support in order to add these origins. Cross-origin resource sharing (CORS) is a mechanism that allows resources on a web page to be requested from another domain outside the domain from which the resource originated.

2016-06-08 Enterprise Events API Changes

We recently added new attributes to events reported via our Enterprise Events API. Events will now display three additional attributes.

  • service_id - Unique, persistent identifier for applications built on top of the Box APIs. This can be used to aggregate events across a single application.
  • service_name - Unique, nonpersistent name for applications that developers can update in the Box developer console.
  • ekm_id - Unique, persistent identifier for customers using Box Keysafe to correlate events with HSM logs.

Here is a sample event:

    {
      "source": {
        "item_type": "file",
        "item_id": "40811830645",
        "item_name": "tigers.jpeg",
        "parent": {
          "type": "folder",
          "name": "All Files",
          "id": "0"
        }
      },
      "created_by": {
        "type": "user",
        "id": "233213282",
        "name": "Joe Smith",
        "login": "joe@email.com"
      },
      "created_at": "2016-05-31T14:03:01-07:00",
      "event_id": "0cb8893d-e314-4f82-b257-f462b4c477f4",
      "event_type": "DOWNLOAD",
      "ip_address": "Unknown IP",
      "type": "event",
      "session_id": null,
      "additional_details": {
        "ekm_id": "8b4364bb-997c-4448-a8bd-5cb6d219ef27",
        "version_id": "40922128381",
        "service_id": "13176",
        "service_name": "My Application"
      }
    }

2016-06-08 Change Notice to Get Embed Link API

We will release the following changes to the preview experience generated from the Get Embed Link API for users on a free plan on July 1 and for users on a paid plan on August 1:

  • Add Box branding to the preview header bar. Customers on an Enterprise plan will have the option for custom branding. Please contact your Box Customer Success Manager for more details.
  • Add download and print buttons to the preview header bar. These buttons will be permissions-based, so only users who have the permission to download the document will be able to see these buttons. The print button will only show on document file types.

If you have any questions about these changes, please reach out to your Customer Success Manager or email content-experience-feedback@box.com

2016-05-18 New Event Type for Enterprise Events

Added FILE_MARKED_MALICIOUS as an enterprise event that indicates a virus is found on a file in Box

2016-03-26 - New Event Types and Attributes for Enterprise Events

In order to support single file collaborations in Box we have introduced two new event types: GROUP_ADD_FILE and GROUP_REMOVE_FILE. Existing event types will also have updated attribute names as well. For developers using the Enterprise Events API, this will impact collaboration event types, including​:​ COLLABORATION_ACCEPT, COLLABORATION_ROLE_CHANGE, UPDATE_COLLABORATION_EXPIRATION, COLLABORATION_REMOVE, COLLABORATION_INVITE, COLLABORATION_EXPIRATION. While current folder-level collaboration events will remain unchanged, collaboration on files has file_id and file_name as source attributes instead of folder_id and folder_name.

2016-02-19 - Embed HD Video and 360 Photos using the Box Content API

We are rolling out a public beta for developers to embed HD videos and Equirectangular (360) photos in their apps using the Box Content API.

API Changelog