Supported APIs for Box Archive

Guides Box Archive Supported APIs for Box Archive

Supported APIs for Box Archive

The basic Box Archive APIs allow you to create, list and delete archives, but you can use other APIs to interact with an archive or its content. See the table below for the full list of those APIs.

Those APIs require the GCM scope to be enabled in your application. This scope is not available in the Developer Console and needs to be enabled by contacting customer support.

Additionally, some of the below APIs need to be enabled by contacting customer support to properly work with Box Archive. When contacting customer support, specify the user ID you plan to use those APIs with.

API Endpoint	Description
`POST /archives`	Create an archive.
`GET /archives`	List all archives.
`DELETE /archives/:id`	Delete an archive.
`PUT /files/:id`	Add a file to an archive, restore a file from an archive, or move file within/between archives. Other updates to the file are not allowed. Requires contacting customer support to enable.
`PUT /folders/:id`	Add a folder to an archive, restore a folder from an archive, or move folder within/between archives. Other updates to the folder are not allowed. Requires contacting customer support to enable.
`POST /files/content`	Upload a file to an archive or to folder within archive. Requires contacting customer support to enable.
`GET /files/:id/content`	Download a file from an archive or from folder within archive.
`POST /zip_downloads`	Download a zip file of an archive or of a folder within archive.
`POST /folders`	Create a folder within an archive. Requires contacting customer support to enable.
`GET /files/:id`	Get details of a file within an archive.
`GET /folders/:id`	Get details of archive or a folder within an archive.
`GET /folders/:id/items`	List items within an archive or a folder within an archive.
`POST /files/:id/copy`	Copy a file within an archive or to another archive.
`POST /folders/:id/copy`	Copy a folder within an archive or to another archive.
`POST /files/:id/metadata/:scope/:template_key`	Create metadata instance on a file within an archive.
`GET /files/:id/metadata/:scope/:template_key`	View metadata instance on a file within an archive.
`GET /files/:id/metadata`	List all metadata instances on a file within an archive.
`PUT /files/:id/metadata/:scope/:template_key`	Update metadata instance on a file within an archive.
`DELETE /files/:id/metadata/:scope/:template_key`	Delete metadata instance on a file within an archive.
`POST securityClassification`	Create a classification label on a file within an archive.
`GET securityClassification`	View a classification label on a file within an archive.
`PUT securityClassification`	Update a classification label on a file within an archive.
`DELETE securityClassification`	Delete a classification label on a file within an archive.