From 5c2d61ed0fc6029b640b7148e55af9b271616696 Mon Sep 17 00:00:00 2001 From: Piotr Satala Date: Mon, 23 Jun 2025 18:31:09 +0200 Subject: [PATCH 01/11] Create guides for Box Archive APIs --- content/guides/archives/add-content.md | 38 ++++++++++++ content/guides/archives/index.md | 41 +++++++++++++ content/guides/archives/restore-content.md | 37 ++++++++++++ content/guides/archives/supported-apis.md | 70 ++++++++++++++++++++++ 4 files changed, 186 insertions(+) create mode 100644 content/guides/archives/add-content.md create mode 100644 content/guides/archives/index.md create mode 100644 content/guides/archives/restore-content.md create mode 100644 content/guides/archives/supported-apis.md diff --git a/content/guides/archives/add-content.md b/content/guides/archives/add-content.md new file mode 100644 index 000000000..145ce0a67 --- /dev/null +++ b/content/guides/archives/add-content.md @@ -0,0 +1,38 @@ +--- +rank: 1 +related_endpoints: + - post-archives + - put-files-id + - put-folders-id +related_resources: + - archive +related_guides: + - archives/restore-content +required_guides: [] +alias_paths: [] +--- + +# Add content to Box Archive + +To be able to add content to an archive, you need to create an archive first. If you +have not done this yet, please use the [Create Archive][Create Archive] endpoint. + +## Add file to archive + +To add a file to an archive, you can use the [`PUT /files/:id`][Update file] API endpoint. +The `id` is the ID of the file you want to add to the archive. +To specify the destination, use the `parent.id` [parameter][Update parent id of file] in the request body. +This can be either an ID of an existing archive or the ID of a folder that is inside an archive. + +## Add folder to archive + +To add a folder to an archive, you can use the [`PUT /folders/:id`][Update folder] API endpoint. +The `id` is the ID of the folder you want to add to the archive. +To specify the destination, use the `parent.id` [parameter][Update parent id of folder] in the request body. +This can be either an ID of an existing archive or the ID of a folder that is inside an archive. + +[Create Archive]: e://post-archives +[Update file]: e://put-files-id +[Update parent id of file]: https://developer.box.com/reference/put-files-id/#param-parent-id +[Update folder]: e://put-folders-id +[Update parent id of folder]: https://developer.box.com/reference/put-folders-id/#param-parent-id diff --git a/content/guides/archives/index.md b/content/guides/archives/index.md new file mode 100644 index 000000000..0e4d171ca --- /dev/null +++ b/content/guides/archives/index.md @@ -0,0 +1,41 @@ +--- +rank: 1 +related_endpoints: + - post-archives + - get-archives + - delete-archives-id + - put-files-id + - put-folders-id +related_resources: + - archive +related_guides: + - archives/add-content + - archives/restore-content + - archives/supported-apis +required_guides: [] +alias_paths: [] +--- + +# Box Archive + +Box Archive is available only for Enterprise Advanced accounts. + +Box Archive allows you to create and manage archives. An archive is a folder dedicated to +storing content that is redundant, outdated, or trivial. Content in an archive is not accessible to its +owner and collaborators. + +## Archives are folders + +Archives are a special type of folder. Box Archive APIs allow you to create, list and delete archives. +However, there are other APIs that also work with archives or with content within archives. +For a full list of supported APIs, see the [Supported APIs][Supported APIs] guide. + +## Required scopes + +Before using any of the Box Archive APIs, make sure you can access [Box Archive in Admin Console][Box Archive in Admin Console]. +Your application must have the `GCM` and `Read and write all files and folders` scopes enabled. +If you plan to only view archives and not modify them, you can use `Read all files and folders` instead of the `Read and write all files and folders` scope. +Please note that the `GCM` scope is not available in the Developer Console and needs to instead be enabled by contacting customer support. + +[Supported APIs]: g://archives/supported-apis +[Box Archive in Admin Console]: https://support.box.com/hc/en-us/p/Product_Page_2023?section-id=40168863437843 diff --git a/content/guides/archives/restore-content.md b/content/guides/archives/restore-content.md new file mode 100644 index 000000000..5625d6aef --- /dev/null +++ b/content/guides/archives/restore-content.md @@ -0,0 +1,37 @@ +--- +rank: 2 +related_endpoints: + - put-files-id + - put-folders-id +related_resources: + - archive +related_guides: + - archives/add-content +required_guides: [] +alias_paths: [] +--- + +# Restore content from Box Archive + +This guide describes how to restore content that has been mistakenly archived. +See [Add content to Box Archive][Add content to archive] for information on how to add content to an archive. + +## Restore file from archive + +To restore a file from an archive, you can use the [`PUT /files/:id`][Update file] API endpoint. +The `id` is the ID of the file you want to restore from an archive. +To specify the destination, use the `parent.id` [parameter][Update parent id of file] in the request body. +This is the ID of an existing folder (can be owned by any user) where you want to restore the file. + +## Restore folder from archive + +To restore a folder from an archive, you can use the [`PUT /folders/:id`][Update folder] API endpoint. +The `id` is the ID of the folder you want to restore from an archive. +To specify the destination, use the `parent.id` [parameter][Update parent id of folder] in the request body. +This is the ID of an existing folder (can be owned by any user) where you want to restore the folder. + +[Add content to archive]: g://archives/add-content +[Update file]: e://put-files-id +[Update parent id of file]: https://developer.box.com/reference/put-files-id/#param-parent-id +[Update folder]: e://put-folders-id +[Update parent id of folder]: https://developer.box.com/reference/put-folders-id/#param-parent-id diff --git a/content/guides/archives/supported-apis.md b/content/guides/archives/supported-apis.md new file mode 100644 index 000000000..cf5baabea --- /dev/null +++ b/content/guides/archives/supported-apis.md @@ -0,0 +1,70 @@ +--- +rank: 3 +related_endpoints: [] +related_resources: + - archive +related_guides: [] +required_guides: [] +alias_paths: [] +--- + +# Supported APIs for Box Archive + +Archives are a special type of folder. Box Archive APIs allow you to create, list and delete archives. +However, there are other APIs that also work with archives or with content within archives. +Below is a table with all APIs that support Box Archive. + + + Those APIs require the `GCM` scope to be enabled in your application. This scope is not available in the Developer Console and needs to instead be enabled by contacting customer support. + + +| API Endpoint | Description | +|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------| +| [`POST /archives`][Create archive] | Create an archive. | +| [`GET /archives`][List archives] | List all archives. | +| [`DELETE /archives/:id`][Delete archive] | Delete an archive. | +| [`PUT /files/:id`][Update file] | Add a file to an archive or restore a file from an archive. | +| [`PUT /folders/:id`][Update folder] | Add a folder to an archive or restore a folder from an archive. | +| [`PUT /web_links/:id`][Update weblink] | Add weblink to an archive or restore a weblink from an archive. | +| [`POST /files/content`][Upload file] | Upload a file to an archive or to folder within archive. | +| [`GET /files/:id/content`][Download file] | Download a file from an archive or from folder within archive. | +| [`POST /zip_downloads`][Download zip] | Download a zip file of an archive or of a folder within archive. | +| [`POST /folders`][Create folder within archive] | Create a folder within an archive. | +| [`GET /files/:id`][Get file details] | Get details of a file within an archive. | +| [`GET /folders/:id`][Get folder details] | Get details of archive or a folder within an archive. | +| [`GET /folders/:id/items`][List folder items] | List items within an archive or a folder within an archive. | +| [`POST /files/:id/metadata/:scope/:template_key`][Create metadata on file] | Create metadata instance on a file within an archive. | +| [`GET /files/:id/metadata/:scope/:template_key`][View metadata on file] | View metadata instance on a file within an archive. | +| [`GET /files/:id/metadata`][List metadata on file] | List all metadata instances on a file within an archive. | +| [`PUT /files/:id/metadata/:scope/:template_key`][Update metadata on file] | Update metadata instance on a file within an archive. | +| [`DELETE /files/:id/metadata/:scope/:template_key`][Delete metadata on file] | Delete metadata instance on a file within an archive. | +| [`POST /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Create classification label on file] | Create a classification label on a file within an archive. | +| [`GET /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][View classification label on file] | View a classification label on a file within an archive. | +| [`PUT /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Update classification label on file] | Update a classification label on a file within an archive. | +| [`DELETE /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Delete classification label on file] | Delete a classification label on a file within an archive. | + +[Create archive]: e://post-archives +[List archives]: e://get-archives +[Delete archive]: e://delete-archives-id +[Update file]: e://put-files-id +[Update folder]: e://put-folders-id +[Update weblink]: e://put-web-links-id +[Upload file]: e://post-files-content +[Download file]: e://get-files-id-content +[Download zip]: e://post-zip-downloads +[Create folder within archive]: e://post-folders +[Get file details]: e://get-files-id +[Get folder details]: e://get-folders-id +[List folder items]: e://get-folders-id-items +[Create metadata on file]: e://post-files-id-metadata-id-id +[View metadata on file]: e://get-files-id-metadata-id-id +[List metadata on file]: e://get-files-id-metadata +[Update metadata on file]: e://put-files-id-metadata-id-id +[Delete metadata on file]: e://delete-files-id-metadata-id-id +[Create classification label on file]: e://post-files-id-metadata-enterprise-securityClassification-6VMVochwUWo +[View classification label on file]: e://get-files-id-metadata-enterprise-securityClassification-6VMVochwUWo +[Update classification label on file]: e://put-files-id-metadata-enterprise-securityClassification-6VMVochwUWo +[Delete classification label on file]: e://delete-files-id-metadata-enterprise-securityClassification-6VMVochwUWo + +[//]: # (TODO: double check the endpoints are supported) + From eef2bf3131146a000deb4bc58ce50f1c08712c82 Mon Sep 17 00:00:00 2001 From: Piotr Satala Date: Mon, 23 Jun 2025 18:32:44 +0200 Subject: [PATCH 02/11] Fix linter issue --- content/guides/archives/supported-apis.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/guides/archives/supported-apis.md b/content/guides/archives/supported-apis.md index cf5baabea..606266919 100644 --- a/content/guides/archives/supported-apis.md +++ b/content/guides/archives/supported-apis.md @@ -67,4 +67,3 @@ Below is a table with all APIs that support Box Archive. [Delete classification label on file]: e://delete-files-id-metadata-enterprise-securityClassification-6VMVochwUWo [//]: # (TODO: double check the endpoints are supported) - From 8e4794975e24c0bbce2cc4dba682896cec4341de Mon Sep 17 00:00:00 2001 From: Piotr Satala Date: Tue, 24 Jun 2025 13:10:02 +0200 Subject: [PATCH 03/11] Address review comments --- content/guides/archives/restore-content.md | 8 ++++++++ content/guides/archives/supported-apis.md | 3 +-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/content/guides/archives/restore-content.md b/content/guides/archives/restore-content.md index 5625d6aef..264113b2f 100644 --- a/content/guides/archives/restore-content.md +++ b/content/guides/archives/restore-content.md @@ -23,6 +23,9 @@ The `id` is the ID of the file you want to restore from an archive. To specify the destination, use the `parent.id` [parameter][Update parent id of file] in the request body. This is the ID of an existing folder (can be owned by any user) where you want to restore the file. +To restore a file to user's root folder, use `0` as the `parent.id` value. Additionally, pass the ID of the user in the +`parent.user_id` [parameter][Update parent user id of file] in the request body. + ## Restore folder from archive To restore a folder from an archive, you can use the [`PUT /folders/:id`][Update folder] API endpoint. @@ -30,8 +33,13 @@ The `id` is the ID of the folder you want to restore from an archive. To specify the destination, use the `parent.id` [parameter][Update parent id of folder] in the request body. This is the ID of an existing folder (can be owned by any user) where you want to restore the folder. +To restore a folder to user's root folder, use `0` as the `parent.id` value. Additionally, pass the ID of the user in the +`parent.user_id` [parameter][Update parent user id of folder] in the request body. + [Add content to archive]: g://archives/add-content [Update file]: e://put-files-id [Update parent id of file]: https://developer.box.com/reference/put-files-id/#param-parent-id +[Update parent user id of file]: https://developer.box.com/reference/put-files-id/#param-parent-user_id [Update folder]: e://put-folders-id [Update parent id of folder]: https://developer.box.com/reference/put-folders-id/#param-parent-id +[Update parent user id of folder]: https://developer.box.com/reference/put-folders-id/#param-parent-user_id diff --git a/content/guides/archives/supported-apis.md b/content/guides/archives/supported-apis.md index 606266919..a704dd65d 100644 --- a/content/guides/archives/supported-apis.md +++ b/content/guides/archives/supported-apis.md @@ -25,7 +25,6 @@ Below is a table with all APIs that support Box Archive. | [`DELETE /archives/:id`][Delete archive] | Delete an archive. | | [`PUT /files/:id`][Update file] | Add a file to an archive or restore a file from an archive. | | [`PUT /folders/:id`][Update folder] | Add a folder to an archive or restore a folder from an archive. | -| [`PUT /web_links/:id`][Update weblink] | Add weblink to an archive or restore a weblink from an archive. | | [`POST /files/content`][Upload file] | Upload a file to an archive or to folder within archive. | | [`GET /files/:id/content`][Download file] | Download a file from an archive or from folder within archive. | | [`POST /zip_downloads`][Download zip] | Download a zip file of an archive or of a folder within archive. | @@ -48,7 +47,6 @@ Below is a table with all APIs that support Box Archive. [Delete archive]: e://delete-archives-id [Update file]: e://put-files-id [Update folder]: e://put-folders-id -[Update weblink]: e://put-web-links-id [Upload file]: e://post-files-content [Download file]: e://get-files-id-content [Download zip]: e://post-zip-downloads @@ -67,3 +65,4 @@ Below is a table with all APIs that support Box Archive. [Delete classification label on file]: e://delete-files-id-metadata-enterprise-securityClassification-6VMVochwUWo [//]: # (TODO: double check the endpoints are supported) +[//]: # (TODO: check copy API) From 3340e203a44cc511ed494346af8c841b0edfbc05 Mon Sep 17 00:00:00 2001 From: Piotr Satala Date: Tue, 24 Jun 2025 14:21:21 +0200 Subject: [PATCH 04/11] Update list of supported APIs --- content/guides/archives/supported-apis.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/content/guides/archives/supported-apis.md b/content/guides/archives/supported-apis.md index a704dd65d..61c0c12c0 100644 --- a/content/guides/archives/supported-apis.md +++ b/content/guides/archives/supported-apis.md @@ -32,6 +32,8 @@ Below is a table with all APIs that support Box Archive. | [`GET /files/:id`][Get file details] | Get details of a file within an archive. | | [`GET /folders/:id`][Get folder details] | Get details of archive or a folder within an archive. | | [`GET /folders/:id/items`][List folder items] | List items within an archive or a folder within an archive. | +| [`POST /files/:id/copy`][Copy file] | Copy a file within an archive or to another archive. | +| [`POST /folders/:id/copy`][Copy folder] | Copy a folder within an archive or to another archive. | | [`POST /files/:id/metadata/:scope/:template_key`][Create metadata on file] | Create metadata instance on a file within an archive. | | [`GET /files/:id/metadata/:scope/:template_key`][View metadata on file] | View metadata instance on a file within an archive. | | [`GET /files/:id/metadata`][List metadata on file] | List all metadata instances on a file within an archive. | @@ -54,6 +56,8 @@ Below is a table with all APIs that support Box Archive. [Get file details]: e://get-files-id [Get folder details]: e://get-folders-id [List folder items]: e://get-folders-id-items +[Copy file]: e://post-files-id-copy +[Copy folder]: e://post-folders-id-copy [Create metadata on file]: e://post-files-id-metadata-id-id [View metadata on file]: e://get-files-id-metadata-id-id [List metadata on file]: e://get-files-id-metadata @@ -63,6 +67,3 @@ Below is a table with all APIs that support Box Archive. [View classification label on file]: e://get-files-id-metadata-enterprise-securityClassification-6VMVochwUWo [Update classification label on file]: e://put-files-id-metadata-enterprise-securityClassification-6VMVochwUWo [Delete classification label on file]: e://delete-files-id-metadata-enterprise-securityClassification-6VMVochwUWo - -[//]: # (TODO: double check the endpoints are supported) -[//]: # (TODO: check copy API) From 6d72996aef1fdf514185b50d0b5c4eb6c7d643db Mon Sep 17 00:00:00 2001 From: Piotr Satala Date: Wed, 25 Jun 2025 11:34:20 +0200 Subject: [PATCH 05/11] Add information about contacting customer support --- content/guides/archives/supported-apis.md | 56 ++++++++++++----------- 1 file changed, 30 insertions(+), 26 deletions(-) diff --git a/content/guides/archives/supported-apis.md b/content/guides/archives/supported-apis.md index 61c0c12c0..3fe2d33b2 100644 --- a/content/guides/archives/supported-apis.md +++ b/content/guides/archives/supported-apis.md @@ -15,34 +15,38 @@ However, there are other APIs that also work with archives or with content withi Below is a table with all APIs that support Box Archive. - Those APIs require the `GCM` scope to be enabled in your application. This scope is not available in the Developer Console and needs to instead be enabled by contacting customer support. + Those APIs require the `GCM` scope to be enabled in your application. + This scope is not available in the Developer Console and needs to instead 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, please specify the user ID you plan to use those APIs with. -| API Endpoint | Description | -|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------| -| [`POST /archives`][Create archive] | Create an archive. | -| [`GET /archives`][List archives] | List all archives. | -| [`DELETE /archives/:id`][Delete archive] | Delete an archive. | -| [`PUT /files/:id`][Update file] | Add a file to an archive or restore a file from an archive. | -| [`PUT /folders/:id`][Update folder] | Add a folder to an archive or restore a folder from an archive. | -| [`POST /files/content`][Upload file] | Upload a file to an archive or to folder within archive. | -| [`GET /files/:id/content`][Download file] | Download a file from an archive or from folder within archive. | -| [`POST /zip_downloads`][Download zip] | Download a zip file of an archive or of a folder within archive. | -| [`POST /folders`][Create folder within archive] | Create a folder within an archive. | -| [`GET /files/:id`][Get file details] | Get details of a file within an archive. | -| [`GET /folders/:id`][Get folder details] | Get details of archive or a folder within an archive. | -| [`GET /folders/:id/items`][List folder items] | List items within an archive or a folder within an archive. | -| [`POST /files/:id/copy`][Copy file] | Copy a file within an archive or to another archive. | -| [`POST /folders/:id/copy`][Copy folder] | Copy a folder within an archive or to another archive. | -| [`POST /files/:id/metadata/:scope/:template_key`][Create metadata on file] | Create metadata instance on a file within an archive. | -| [`GET /files/:id/metadata/:scope/:template_key`][View metadata on file] | View metadata instance on a file within an archive. | -| [`GET /files/:id/metadata`][List metadata on file] | List all metadata instances on a file within an archive. | -| [`PUT /files/:id/metadata/:scope/:template_key`][Update metadata on file] | Update metadata instance on a file within an archive. | -| [`DELETE /files/:id/metadata/:scope/:template_key`][Delete metadata on file] | Delete metadata instance on a file within an archive. | -| [`POST /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Create classification label on file] | Create a classification label on a file within an archive. | -| [`GET /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][View classification label on file] | View a classification label on a file within an archive. | -| [`PUT /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Update classification label on file] | Update a classification label on a file within an archive. | -| [`DELETE /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Delete classification label on file] | Delete a classification label on a file within an archive. | +| API Endpoint | Description | +|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| +| [`POST /archives`][Create archive] | Create an archive. | +| [`GET /archives`][List archives] | List all archives. | +| [`DELETE /archives/:id`][Delete archive] | Delete an archive. | +| [`PUT /files/:id`][Update file] | Add a file to an archive or restore a file from an archive. Requires contacting customer support to enable. | +| [`PUT /folders/:id`][Update folder] | Add a folder to an archive or restore a folder from an archive. Requires contacting customer support to enable. | +| [`POST /files/content`][Upload file] | Upload a file to an archive or to folder within archive. Requires contacting customer support to enable. | +| [`GET /files/:id/content`][Download file] | Download a file from an archive or from folder within archive. | +| [`POST /zip_downloads`][Download zip] | Download a zip file of an archive or of a folder within archive. | +| [`POST /folders`][Create folder within archive] | Create a folder within an archive. Requires contacting customer support to enable. | +| [`GET /files/:id`][Get file details] | Get details of a file within an archive. | +| [`GET /folders/:id`][Get folder details] | Get details of archive or a folder within an archive. | +| [`GET /folders/:id/items`][List folder items] | List items within an archive or a folder within an archive. | +| [`POST /files/:id/copy`][Copy file] | Copy a file within an archive or to another archive. | +| [`POST /folders/:id/copy`][Copy folder] | Copy a folder within an archive or to another archive. | +| [`POST /files/:id/metadata/:scope/:template_key`][Create metadata on file] | Create metadata instance on a file within an archive. | +| [`GET /files/:id/metadata/:scope/:template_key`][View metadata on file] | View metadata instance on a file within an archive. | +| [`GET /files/:id/metadata`][List metadata on file] | List all metadata instances on a file within an archive. | +| [`PUT /files/:id/metadata/:scope/:template_key`][Update metadata on file] | Update metadata instance on a file within an archive. | +| [`DELETE /files/:id/metadata/:scope/:template_key`][Delete metadata on file] | Delete metadata instance on a file within an archive. | +| [`POST /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Create classification label on file] | Create a classification label on a file within an archive. | +| [`GET /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][View classification label on file] | View a classification label on a file within an archive. | +| [`PUT /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Update classification label on file] | Update a classification label on a file within an archive. | +| [`DELETE /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Delete classification label on file] | Delete a classification label on a file within an archive. | [Create archive]: e://post-archives [List archives]: e://get-archives From 3aece7923cd5d2ba5f6ab654fef05d77fc631be5 Mon Sep 17 00:00:00 2001 From: Piotr Satala Date: Thu, 26 Jun 2025 11:19:19 +0200 Subject: [PATCH 06/11] Add information about not allowing edits --- content/guides/archives/supported-apis.md | 50 +++++++++++------------ 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/content/guides/archives/supported-apis.md b/content/guides/archives/supported-apis.md index 3fe2d33b2..c297b2da8 100644 --- a/content/guides/archives/supported-apis.md +++ b/content/guides/archives/supported-apis.md @@ -22,31 +22,31 @@ Below is a table with all APIs that support Box Archive. When contacting customer support, please specify the user ID you plan to use those APIs with. -| API Endpoint | Description | -|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| -| [`POST /archives`][Create archive] | Create an archive. | -| [`GET /archives`][List archives] | List all archives. | -| [`DELETE /archives/:id`][Delete archive] | Delete an archive. | -| [`PUT /files/:id`][Update file] | Add a file to an archive or restore a file from an archive. Requires contacting customer support to enable. | -| [`PUT /folders/:id`][Update folder] | Add a folder to an archive or restore a folder from an archive. Requires contacting customer support to enable. | -| [`POST /files/content`][Upload file] | Upload a file to an archive or to folder within archive. Requires contacting customer support to enable. | -| [`GET /files/:id/content`][Download file] | Download a file from an archive or from folder within archive. | -| [`POST /zip_downloads`][Download zip] | Download a zip file of an archive or of a folder within archive. | -| [`POST /folders`][Create folder within archive] | Create a folder within an archive. Requires contacting customer support to enable. | -| [`GET /files/:id`][Get file details] | Get details of a file within an archive. | -| [`GET /folders/:id`][Get folder details] | Get details of archive or a folder within an archive. | -| [`GET /folders/:id/items`][List folder items] | List items within an archive or a folder within an archive. | -| [`POST /files/:id/copy`][Copy file] | Copy a file within an archive or to another archive. | -| [`POST /folders/:id/copy`][Copy folder] | Copy a folder within an archive or to another archive. | -| [`POST /files/:id/metadata/:scope/:template_key`][Create metadata on file] | Create metadata instance on a file within an archive. | -| [`GET /files/:id/metadata/:scope/:template_key`][View metadata on file] | View metadata instance on a file within an archive. | -| [`GET /files/:id/metadata`][List metadata on file] | List all metadata instances on a file within an archive. | -| [`PUT /files/:id/metadata/:scope/:template_key`][Update metadata on file] | Update metadata instance on a file within an archive. | -| [`DELETE /files/:id/metadata/:scope/:template_key`][Delete metadata on file] | Delete metadata instance on a file within an archive. | -| [`POST /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Create classification label on file] | Create a classification label on a file within an archive. | -| [`GET /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][View classification label on file] | View a classification label on a file within an archive. | -| [`PUT /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Update classification label on file] | Update a classification label on a file within an archive. | -| [`DELETE /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Delete classification label on file] | Delete a classification label on a file within an archive. | +| API Endpoint | Description | +|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`POST /archives`][Create archive] | Create an archive. | +| [`GET /archives`][List archives] | List all archives. | +| [`DELETE /archives/:id`][Delete archive] | Delete an archive. | +| [`PUT /files/:id`][Update file] | Add a file to an archive or restore a file from an archive. Other updates to the file are not allowed. Requires contacting customer support to enable. | +| [`PUT /folders/:id`][Update folder] | Add a folder to an archive or restore a folder from an archive. Other updates to the folder are not allowed. Requires contacting customer support to enable. | +| [`POST /files/content`][Upload file] | Upload a file to an archive or to folder within archive. Requires contacting customer support to enable. | +| [`GET /files/:id/content`][Download file] | Download a file from an archive or from folder within archive. | +| [`POST /zip_downloads`][Download zip] | Download a zip file of an archive or of a folder within archive. | +| [`POST /folders`][Create folder within archive] | Create a folder within an archive. Requires contacting customer support to enable. | +| [`GET /files/:id`][Get file details] | Get details of a file within an archive. | +| [`GET /folders/:id`][Get folder details] | Get details of archive or a folder within an archive. | +| [`GET /folders/:id/items`][List folder items] | List items within an archive or a folder within an archive. | +| [`POST /files/:id/copy`][Copy file] | Copy a file within an archive or to another archive. | +| [`POST /folders/:id/copy`][Copy folder] | Copy a folder within an archive or to another archive. | +| [`POST /files/:id/metadata/:scope/:template_key`][Create metadata on file] | Create metadata instance on a file within an archive. | +| [`GET /files/:id/metadata/:scope/:template_key`][View metadata on file] | View metadata instance on a file within an archive. | +| [`GET /files/:id/metadata`][List metadata on file] | List all metadata instances on a file within an archive. | +| [`PUT /files/:id/metadata/:scope/:template_key`][Update metadata on file] | Update metadata instance on a file within an archive. | +| [`DELETE /files/:id/metadata/:scope/:template_key`][Delete metadata on file] | Delete metadata instance on a file within an archive. | +| [`POST /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Create classification label on file] | Create a classification label on a file within an archive. | +| [`GET /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][View classification label on file] | View a classification label on a file within an archive. | +| [`PUT /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Update classification label on file] | Update a classification label on a file within an archive. | +| [`DELETE /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Delete classification label on file] | Delete a classification label on a file within an archive. | [Create archive]: e://post-archives [List archives]: e://get-archives From 4eb815583e75403bd543094be3536bd72a9cab40 Mon Sep 17 00:00:00 2001 From: Piotr Satala Date: Fri, 27 Jun 2025 18:03:16 +0200 Subject: [PATCH 07/11] Address review comments --- content/guides/archives/index.md | 4 +- content/guides/archives/supported-apis.md | 50 +++++++++++------------ 2 files changed, 27 insertions(+), 27 deletions(-) diff --git a/content/guides/archives/index.md b/content/guides/archives/index.md index 0e4d171ca..0bcb29eed 100644 --- a/content/guides/archives/index.md +++ b/content/guides/archives/index.md @@ -21,8 +21,8 @@ alias_paths: [] Box Archive is available only for Enterprise Advanced accounts. Box Archive allows you to create and manage archives. An archive is a folder dedicated to -storing content that is redundant, outdated, or trivial. Content in an archive is not accessible to its -owner and collaborators. +storing content that is redundant, outdated, or trivial. Content in an archive is owned by the enterprise, +it is not accessible to previous owner and collaborators. ## Archives are folders diff --git a/content/guides/archives/supported-apis.md b/content/guides/archives/supported-apis.md index c297b2da8..19f87e5f3 100644 --- a/content/guides/archives/supported-apis.md +++ b/content/guides/archives/supported-apis.md @@ -22,31 +22,31 @@ Below is a table with all APIs that support Box Archive. When contacting customer support, please specify the user ID you plan to use those APIs with. -| API Endpoint | Description | -|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`POST /archives`][Create archive] | Create an archive. | -| [`GET /archives`][List archives] | List all archives. | -| [`DELETE /archives/:id`][Delete archive] | Delete an archive. | -| [`PUT /files/:id`][Update file] | Add a file to an archive or restore a file from an archive. Other updates to the file are not allowed. Requires contacting customer support to enable. | -| [`PUT /folders/:id`][Update folder] | Add a folder to an archive or restore a folder from an archive. Other updates to the folder are not allowed. Requires contacting customer support to enable. | -| [`POST /files/content`][Upload file] | Upload a file to an archive or to folder within archive. Requires contacting customer support to enable. | -| [`GET /files/:id/content`][Download file] | Download a file from an archive or from folder within archive. | -| [`POST /zip_downloads`][Download zip] | Download a zip file of an archive or of a folder within archive. | -| [`POST /folders`][Create folder within archive] | Create a folder within an archive. Requires contacting customer support to enable. | -| [`GET /files/:id`][Get file details] | Get details of a file within an archive. | -| [`GET /folders/:id`][Get folder details] | Get details of archive or a folder within an archive. | -| [`GET /folders/:id/items`][List folder items] | List items within an archive or a folder within an archive. | -| [`POST /files/:id/copy`][Copy file] | Copy a file within an archive or to another archive. | -| [`POST /folders/:id/copy`][Copy folder] | Copy a folder within an archive or to another archive. | -| [`POST /files/:id/metadata/:scope/:template_key`][Create metadata on file] | Create metadata instance on a file within an archive. | -| [`GET /files/:id/metadata/:scope/:template_key`][View metadata on file] | View metadata instance on a file within an archive. | -| [`GET /files/:id/metadata`][List metadata on file] | List all metadata instances on a file within an archive. | -| [`PUT /files/:id/metadata/:scope/:template_key`][Update metadata on file] | Update metadata instance on a file within an archive. | -| [`DELETE /files/:id/metadata/:scope/:template_key`][Delete metadata on file] | Delete metadata instance on a file within an archive. | -| [`POST /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Create classification label on file] | Create a classification label on a file within an archive. | -| [`GET /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][View classification label on file] | View a classification label on a file within an archive. | -| [`PUT /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Update classification label on file] | Update a classification label on a file within an archive. | -| [`DELETE /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Delete classification label on file] | Delete a classification label on a file within an archive. | +| API Endpoint | Description | +|-------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`POST /archives`][Create archive] | Create an archive. | +| [`GET /archives`][List archives] | List all archives. | +| [`DELETE /archives/:id`][Delete archive] | Delete an archive. | +| [`PUT /files/:id`][Update file] | 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`][Update folder] | 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 file] | Upload a file to an archive or to folder within archive. Requires contacting customer support to enable. | +| [`GET /files/:id/content`][Download file] | Download a file from an archive or from folder within archive. | +| [`POST /zip_downloads`][Download zip] | Download a zip file of an archive or of a folder within archive. | +| [`POST /folders`][Create folder within archive] | Create a folder within an archive. Requires contacting customer support to enable. | +| [`GET /files/:id`][Get file details] | Get details of a file within an archive. | +| [`GET /folders/:id`][Get folder details] | Get details of archive or a folder within an archive. | +| [`GET /folders/:id/items`][List folder items] | List items within an archive or a folder within an archive. | +| [`POST /files/:id/copy`][Copy file] | Copy a file within an archive or to another archive. | +| [`POST /folders/:id/copy`][Copy folder] | Copy a folder within an archive or to another archive. | +| [`POST /files/:id/metadata/:scope/:template_key`][Create metadata on file] | Create metadata instance on a file within an archive. | +| [`GET /files/:id/metadata/:scope/:template_key`][View metadata on file] | View metadata instance on a file within an archive. | +| [`GET /files/:id/metadata`][List metadata on file] | List all metadata instances on a file within an archive. | +| [`PUT /files/:id/metadata/:scope/:template_key`][Update metadata on file] | Update metadata instance on a file within an archive. | +| [`DELETE /files/:id/metadata/:scope/:template_key`][Delete metadata on file] | Delete metadata instance on a file within an archive. | +| [`POST /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Create classification label on file] | Create a classification label on a file within an archive. | +| [`GET /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][View classification label on file] | View a classification label on a file within an archive. | +| [`PUT /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Update classification label on file] | Update a classification label on a file within an archive. | +| [`DELETE /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Delete classification label on file] | Delete a classification label on a file within an archive. | [Create archive]: e://post-archives [List archives]: e://get-archives From 9f64ff580d0c84e1e65a50d6c3344a3530f8a02e Mon Sep 17 00:00:00 2001 From: Piotr Satala Date: Fri, 27 Jun 2025 18:25:15 +0200 Subject: [PATCH 08/11] Update wording --- content/guides/archives/add-content.md | 4 ++-- content/guides/archives/restore-content.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/guides/archives/add-content.md b/content/guides/archives/add-content.md index 145ce0a67..9dad288a5 100644 --- a/content/guides/archives/add-content.md +++ b/content/guides/archives/add-content.md @@ -22,14 +22,14 @@ have not done this yet, please use the [Create Archive][Create Archive] endpoint To add a file to an archive, you can use the [`PUT /files/:id`][Update file] API endpoint. The `id` is the ID of the file you want to add to the archive. To specify the destination, use the `parent.id` [parameter][Update parent id of file] in the request body. -This can be either an ID of an existing archive or the ID of a folder that is inside an archive. +This can be either an ID of an archive or the ID of a folder that is inside an archive. ## Add folder to archive To add a folder to an archive, you can use the [`PUT /folders/:id`][Update folder] API endpoint. The `id` is the ID of the folder you want to add to the archive. To specify the destination, use the `parent.id` [parameter][Update parent id of folder] in the request body. -This can be either an ID of an existing archive or the ID of a folder that is inside an archive. +This can be either an ID of an archive or the ID of a folder that is inside an archive. [Create Archive]: e://post-archives [Update file]: e://put-files-id diff --git a/content/guides/archives/restore-content.md b/content/guides/archives/restore-content.md index 264113b2f..e3f43c40c 100644 --- a/content/guides/archives/restore-content.md +++ b/content/guides/archives/restore-content.md @@ -21,7 +21,7 @@ See [Add content to Box Archive][Add content to archive] for information on how To restore a file from an archive, you can use the [`PUT /files/:id`][Update file] API endpoint. The `id` is the ID of the file you want to restore from an archive. To specify the destination, use the `parent.id` [parameter][Update parent id of file] in the request body. -This is the ID of an existing folder (can be owned by any user) where you want to restore the file. +This is the ID of a folder (can be owned by any user) where you want to restore the file. To restore a file to user's root folder, use `0` as the `parent.id` value. Additionally, pass the ID of the user in the `parent.user_id` [parameter][Update parent user id of file] in the request body. @@ -31,7 +31,7 @@ To restore a file to user's root folder, use `0` as the `parent.id` value. Addit To restore a folder from an archive, you can use the [`PUT /folders/:id`][Update folder] API endpoint. The `id` is the ID of the folder you want to restore from an archive. To specify the destination, use the `parent.id` [parameter][Update parent id of folder] in the request body. -This is the ID of an existing folder (can be owned by any user) where you want to restore the folder. +This is the ID of a folder (can be owned by any user) where you want to restore the folder. To restore a folder to user's root folder, use `0` as the `parent.id` value. Additionally, pass the ID of the user in the `parent.user_id` [parameter][Update parent user id of folder] in the request body. From d91aab4e0378cff5ad89a880fe40cdfd9da49fb0 Mon Sep 17 00:00:00 2001 From: Piotr Satala Date: Mon, 30 Jun 2025 15:57:36 +0200 Subject: [PATCH 09/11] Apply review comments --- content/guides/archives/add-content.md | 6 +++--- content/guides/archives/index.md | 6 ++++-- content/guides/archives/restore-content.md | 5 ++--- content/guides/archives/supported-apis.md | 2 +- 4 files changed, 10 insertions(+), 9 deletions(-) diff --git a/content/guides/archives/add-content.md b/content/guides/archives/add-content.md index 9dad288a5..a4efb728e 100644 --- a/content/guides/archives/add-content.md +++ b/content/guides/archives/add-content.md @@ -15,19 +15,19 @@ alias_paths: [] # Add content to Box Archive To be able to add content to an archive, you need to create an archive first. If you -have not done this yet, please use the [Create Archive][Create Archive] endpoint. +have not done this yet, use the [Create Archive][Create Archive] endpoint. ## Add file to archive To add a file to an archive, you can use the [`PUT /files/:id`][Update file] API endpoint. -The `id` is the ID of the file you want to add to the archive. +The `id` parameter is the ID of the file you want to add to the archive. To specify the destination, use the `parent.id` [parameter][Update parent id of file] in the request body. This can be either an ID of an archive or the ID of a folder that is inside an archive. ## Add folder to archive To add a folder to an archive, you can use the [`PUT /folders/:id`][Update folder] API endpoint. -The `id` is the ID of the folder you want to add to the archive. +The `id` parameter is the ID of the folder you want to add to the archive. To specify the destination, use the `parent.id` [parameter][Update parent id of folder] in the request body. This can be either an ID of an archive or the ID of a folder that is inside an archive. diff --git a/content/guides/archives/index.md b/content/guides/archives/index.md index 0bcb29eed..3a3628322 100644 --- a/content/guides/archives/index.md +++ b/content/guides/archives/index.md @@ -18,7 +18,9 @@ alias_paths: [] # Box Archive + Box Archive is available only for Enterprise Advanced accounts. + Box Archive allows you to create and manage archives. An archive is a folder dedicated to storing content that is redundant, outdated, or trivial. Content in an archive is owned by the enterprise, @@ -33,9 +35,9 @@ For a full list of supported APIs, see the [Supported APIs][Supported APIs] guid ## Required scopes Before using any of the Box Archive APIs, make sure you can access [Box Archive in Admin Console][Box Archive in Admin Console]. -Your application must have the `GCM` and `Read and write all files and folders` scopes enabled. +Your Box Platform app must have the `GCM` and `Read and write all files and folders` scopes enabled. If you plan to only view archives and not modify them, you can use `Read all files and folders` instead of the `Read and write all files and folders` scope. -Please note that the `GCM` scope is not available in the Developer Console and needs to instead be enabled by contacting customer support. +Please note that the `GCM` scope is not available in the Developer Console and needs to be enabled by contacting customer support. [Supported APIs]: g://archives/supported-apis [Box Archive in Admin Console]: https://support.box.com/hc/en-us/p/Product_Page_2023?section-id=40168863437843 diff --git a/content/guides/archives/restore-content.md b/content/guides/archives/restore-content.md index e3f43c40c..5d147b6a5 100644 --- a/content/guides/archives/restore-content.md +++ b/content/guides/archives/restore-content.md @@ -14,12 +14,11 @@ alias_paths: [] # Restore content from Box Archive This guide describes how to restore content that has been mistakenly archived. -See [Add content to Box Archive][Add content to archive] for information on how to add content to an archive. ## Restore file from archive To restore a file from an archive, you can use the [`PUT /files/:id`][Update file] API endpoint. -The `id` is the ID of the file you want to restore from an archive. +The `id` parameter is the ID of the file you want to restore from an archive. To specify the destination, use the `parent.id` [parameter][Update parent id of file] in the request body. This is the ID of a folder (can be owned by any user) where you want to restore the file. @@ -29,7 +28,7 @@ To restore a file to user's root folder, use `0` as the `parent.id` value. Addit ## Restore folder from archive To restore a folder from an archive, you can use the [`PUT /folders/:id`][Update folder] API endpoint. -The `id` is the ID of the folder you want to restore from an archive. +The `id` parameter is the ID of the folder you want to restore from an archive. To specify the destination, use the `parent.id` [parameter][Update parent id of folder] in the request body. This is the ID of a folder (can be owned by any user) where you want to restore the folder. diff --git a/content/guides/archives/supported-apis.md b/content/guides/archives/supported-apis.md index 19f87e5f3..78a6afe83 100644 --- a/content/guides/archives/supported-apis.md +++ b/content/guides/archives/supported-apis.md @@ -16,7 +16,7 @@ Below is a table with all APIs that support Box Archive. Those APIs require the `GCM` scope to be enabled in your application. - This scope is not available in the Developer Console and needs to instead be enabled by contacting customer support. + 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, please specify the user ID you plan to use those APIs with. From 117a9bd043b49fc9d2cb390807c5426bd8079de3 Mon Sep 17 00:00:00 2001 From: Piotr Satala Date: Thu, 24 Jul 2025 19:04:30 +0200 Subject: [PATCH 10/11] Apply review comments --- content/guides/archives/add-content.md | 15 ++++--------- content/guides/archives/index.md | 14 +++++++----- content/guides/archives/restore-content.md | 25 ++++++---------------- content/guides/archives/supported-apis.md | 10 ++++----- 4 files changed, 25 insertions(+), 39 deletions(-) diff --git a/content/guides/archives/add-content.md b/content/guides/archives/add-content.md index a4efb728e..c0723c1e9 100644 --- a/content/guides/archives/add-content.md +++ b/content/guides/archives/add-content.md @@ -14,20 +14,13 @@ alias_paths: [] # Add content to Box Archive -To be able to add content to an archive, you need to create an archive first. If you +To add content to an archive, you need to create it first. If you have not done this yet, use the [Create Archive][Create Archive] endpoint. -## Add file to archive +## Add file or folder to archive -To add a file to an archive, you can use the [`PUT /files/:id`][Update file] API endpoint. -The `id` parameter is the ID of the file you want to add to the archive. -To specify the destination, use the `parent.id` [parameter][Update parent id of file] in the request body. -This can be either an ID of an archive or the ID of a folder that is inside an archive. - -## Add folder to archive - -To add a folder to an archive, you can use the [`PUT /folders/:id`][Update folder] API endpoint. -The `id` parameter is the ID of the folder you want to add to the archive. +Use the [`PUT /files/:id`][Update file] API endpoint to add a file to an archive, or the [`PUT /folders/:id`][Update folder] endpoint to add a folder. +The `id` parameter is the ID of the file/folder you want to add to the archive. To specify the destination, use the `parent.id` [parameter][Update parent id of folder] in the request body. This can be either an ID of an archive or the ID of a folder that is inside an archive. diff --git a/content/guides/archives/index.md b/content/guides/archives/index.md index 3a3628322..10aeb7da1 100644 --- a/content/guides/archives/index.md +++ b/content/guides/archives/index.md @@ -24,20 +24,24 @@ Box Archive is available only for Enterprise Advanced accounts. Box Archive allows you to create and manage archives. An archive is a folder dedicated to storing content that is redundant, outdated, or trivial. Content in an archive is owned by the enterprise, -it is not accessible to previous owner and collaborators. +and it is not accessible to previous owner and collaborators. ## Archives are folders -Archives are a special type of folder. Box Archive APIs allow you to create, list and delete archives. +Archives are a special type of folders. Box Archive APIs allow you to create, list and delete archives. However, there are other APIs that also work with archives or with content within archives. For a full list of supported APIs, see the [Supported APIs][Supported APIs] guide. ## Required scopes Before using any of the Box Archive APIs, make sure you can access [Box Archive in Admin Console][Box Archive in Admin Console]. -Your Box Platform app must have the `GCM` and `Read and write all files and folders` scopes enabled. -If you plan to only view archives and not modify them, you can use `Read all files and folders` instead of the `Read and write all files and folders` scope. -Please note that the `GCM` scope is not available in the Developer Console and needs to be enabled by contacting customer support. +Your Box Platform app must have the `GCM` and `Read and write all files and folders` [scopes][Scopes] enabled. +If you plan to only view archives and not modify them, use the `Read all files and folders` instead of the `Read and write all files and folders` scope. + + +The `GCM` scope is not available in the Developer Console and needs to be enabled by contacting customer support. + [Supported APIs]: g://archives/supported-apis [Box Archive in Admin Console]: https://support.box.com/hc/en-us/p/Product_Page_2023?section-id=40168863437843 +[Scopes]: https://developer.box.com/guides/api-calls/permissions-and-errors/scopes/ diff --git a/content/guides/archives/restore-content.md b/content/guides/archives/restore-content.md index 5d147b6a5..725f04f84 100644 --- a/content/guides/archives/restore-content.md +++ b/content/guides/archives/restore-content.md @@ -13,29 +13,18 @@ alias_paths: [] # Restore content from Box Archive -This guide describes how to restore content that has been mistakenly archived. +This guide describes how to restore content that you archived by mistake. -## Restore file from archive +## Restore file or folder from archive -To restore a file from an archive, you can use the [`PUT /files/:id`][Update file] API endpoint. -The `id` parameter is the ID of the file you want to restore from an archive. -To specify the destination, use the `parent.id` [parameter][Update parent id of file] in the request body. -This is the ID of a folder (can be owned by any user) where you want to restore the file. - -To restore a file to user's root folder, use `0` as the `parent.id` value. Additionally, pass the ID of the user in the -`parent.user_id` [parameter][Update parent user id of file] in the request body. - -## Restore folder from archive - -To restore a folder from an archive, you can use the [`PUT /folders/:id`][Update folder] API endpoint. -The `id` parameter is the ID of the folder you want to restore from an archive. +Use the [`PUT /files/:id`][Update file] API endpoint to restore a file from an archive, or the [`PUT /folders/:id`][Update folder] endpoint to restore a folder from an archive. +The `id` parameter is the ID of the file/folder you want to restore from an archive. To specify the destination, use the `parent.id` [parameter][Update parent id of folder] in the request body. -This is the ID of a folder (can be owned by any user) where you want to restore the folder. +This is the ID of a folder (can be owned by any user) where you want to restore the file/folder. -To restore a folder to user's root folder, use `0` as the `parent.id` value. Additionally, pass the ID of the user in the -`parent.user_id` [parameter][Update parent user id of folder] in the request body. +To restore a file/folder to user's root folder, use `0` as the `parent.id` value. Additionally, pass the ID of the user in the +`parent.user_id` [parameter][Update parent user id of file] in the request body. -[Add content to archive]: g://archives/add-content [Update file]: e://put-files-id [Update parent id of file]: https://developer.box.com/reference/put-files-id/#param-parent-id [Update parent user id of file]: https://developer.box.com/reference/put-files-id/#param-parent-user_id diff --git a/content/guides/archives/supported-apis.md b/content/guides/archives/supported-apis.md index 78a6afe83..5e5bace93 100644 --- a/content/guides/archives/supported-apis.md +++ b/content/guides/archives/supported-apis.md @@ -10,16 +10,15 @@ alias_paths: [] # Supported APIs for Box Archive -Archives are a special type of folder. Box Archive APIs allow you to create, list and delete archives. -However, there are other APIs that also work with archives or with content within archives. -Below is a table with all APIs that support 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. + Those APIs require the [`GCM` scope][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, please specify the user ID you plan to use those APIs with. + When contacting customer support, specify the user ID you plan to use those APIs with. | API Endpoint | Description | @@ -71,3 +70,4 @@ Below is a table with all APIs that support Box Archive. [View classification label on file]: e://get-files-id-metadata-enterprise-securityClassification-6VMVochwUWo [Update classification label on file]: e://put-files-id-metadata-enterprise-securityClassification-6VMVochwUWo [Delete classification label on file]: e://delete-files-id-metadata-enterprise-securityClassification-6VMVochwUWo +[GCM scope]: https://developer.box.com/guides/api-calls/permissions-and-errors/scopes/#global-content-manager-gcm From f73c1a09b2f1059da7f73f216541184b7d3cf138 Mon Sep 17 00:00:00 2001 From: Piotr Satala Date: Fri, 25 Jul 2025 13:43:35 +0200 Subject: [PATCH 11/11] Fix URLs in the archives guide --- content/guides/archives/add-content.md | 2 +- content/guides/archives/restore-content.md | 2 +- content/guides/archives/supported-apis.md | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/content/guides/archives/add-content.md b/content/guides/archives/add-content.md index c0723c1e9..cbc375a41 100644 --- a/content/guides/archives/add-content.md +++ b/content/guides/archives/add-content.md @@ -24,7 +24,7 @@ The `id` parameter is the ID of the file/folder you want to add to the archive. To specify the destination, use the `parent.id` [parameter][Update parent id of folder] in the request body. This can be either an ID of an archive or the ID of a folder that is inside an archive. -[Create Archive]: e://post-archives +[Create Archive]: https://developer.box.com/reference/v2025.0/post-archives/ [Update file]: e://put-files-id [Update parent id of file]: https://developer.box.com/reference/put-files-id/#param-parent-id [Update folder]: e://put-folders-id diff --git a/content/guides/archives/restore-content.md b/content/guides/archives/restore-content.md index 725f04f84..a08325ff9 100644 --- a/content/guides/archives/restore-content.md +++ b/content/guides/archives/restore-content.md @@ -23,7 +23,7 @@ To specify the destination, use the `parent.id` [parameter][Update parent id of This is the ID of a folder (can be owned by any user) where you want to restore the file/folder. To restore a file/folder to user's root folder, use `0` as the `parent.id` value. Additionally, pass the ID of the user in the -`parent.user_id` [parameter][Update parent user id of file] in the request body. +`parent.user_id` [parameter][Update parent user id of folder] in the request body. [Update file]: e://put-files-id [Update parent id of file]: https://developer.box.com/reference/put-files-id/#param-parent-id diff --git a/content/guides/archives/supported-apis.md b/content/guides/archives/supported-apis.md index 5e5bace93..beb7e17c9 100644 --- a/content/guides/archives/supported-apis.md +++ b/content/guides/archives/supported-apis.md @@ -47,9 +47,9 @@ See the table below for the full list of those APIs. | [`PUT /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Update classification label on file] | Update a classification label on a file within an archive. | | [`DELETE /files/:id/metadata/enterprise/securityClassification/6VMVochwUWo`][Delete classification label on file] | Delete a classification label on a file within an archive. | -[Create archive]: e://post-archives -[List archives]: e://get-archives -[Delete archive]: e://delete-archives-id +[Create archive]: https://developer.box.com/reference/v2025.0/post-archives/ +[List archives]: https://developer.box.com/reference/v2025.0/get-archives/ +[Delete archive]: https://developer.box.com/reference/v2025.0/delete-archives-id/ [Update file]: e://put-files-id [Update folder]: e://put-folders-id [Upload file]: e://post-files-content