Skip to content

Fix supported APIs table formatting in Archive guide #783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
psatala-box merged 5 commits into from
Jul 29, 2025
Merged

Fix supported APIs table formatting in Archive guide #783

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8995935
Fix supported APIs table formatting in Archive guide
psatala-box Jul 29, 2025
16ac55e
Update table formatting
psatala-box Jul 29, 2025
18b7d6a
Revert "Update table formatting"
psatala-box Jul 29, 2025
64bf963
Update table formatting
psatala-box Jul 29, 2025
86f54da
Change classification URLs to simpler format
psatala-box Jul 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions content/guides/archives/supported-apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,31 +21,31 @@ See the table below for the full list of those APIs.
When contacting customer support, specify the user ID you plan to use those APIs with.
</Message>

| 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. |
| 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 securityClassification`][Create classification label on file] | Create a classification label on a file within an archive. |
| [`GET securityClassification`][View classification label on file] | View a classification label on a file within an archive. |
| [`PUT securityClassification`][Update classification label on file] | Update a classification label on a file within an archive. |
| [`DELETE securityClassification`][Delete classification label on file] | Delete a classification label on a file within an archive. |

[Create archive]: https://developer.box.com/reference/v2025.0/post-archives/
[List archives]: https://developer.box.com/reference/v2025.0/get-archives/
Expand Down
Loading