Skip to content

Commit 37c472f

Browse files
shurreyshurrey
authored
Merge branch 'main' into smh-llms-txt-plugin
2 parents ede8b34 + 6a9cbc6 commit 37c472f

14 files changed

Lines changed: 390 additions & 205 deletions

‎.spelling‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,7 @@ repo
223223
Dev
224224
timeframe
225225
dataset
226+
datasets
226227
deduplicated
227228
deduplicate
228229
stream_types
@@ -360,3 +361,4 @@ natively
360361
Kus
361362
multiselect
362363
add-ons
364+
65k

‎content/guides/applications/web-app-integrations/configure.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ You will be able to deactivate them and change the implementation to a new one.
2727
## Create an OAuth 2.0 Application
2828

2929
Navigate to the [Developer Console][devconsole] and create a [Platform App][ca]
30-
that leverages [OAuth 2.0 authentication][custom-oauth2].
30+
that leverages [OAuth 2.0 authentication][custom-oauth2].
3131

3232
## Create a New Integration
3333

@@ -60,6 +60,7 @@ To configure the integration, follow the guidance below for each value.
6060
| Field | Description |
6161
|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
6262
| Client Callback URL | Handles additional callback requests from Box after the primary request with [Popup Integrations][pu]. If the application specifies a file parameter in the REST method, the preliminary callback URL cannot originate from the client. As a result, a second request must be made from the client to your server so the server can send the necessary interface to the user. |
63+
| Prompt Message | Specifies the message that users see when they initiate the integration. Use this field to provide context about what happens next. The message is limited to 500 characters. |
6364
| User Experience | Informs that the integration will open in a new window.|
6465
| New Window Settings | Determines if the application opens in a new tab. |
6566

@@ -68,29 +69,28 @@ To configure the integration, follow the guidance below for each value.
6869
The **Callback Parameters** section configures the parameters that Box sends to
6970
the callback URL when a user accepts a confirmation prompt. If this setting is
7071
not configured, Box does not send any parameters to the callback URL.
71-
To add a parameter, select the **Method**,
72+
To add a parameter, select the **Method** (GET or POST),
7273
specify the **Parameter name** and add a **Parameter value**.
73-
Available methods are **Get** and **Post**.
7474

7575
<message type='warning'>
7676
The **File** method is no longer supported. If you already used this method,
77-
you cannot edit its values. You can change the **File** method to **Get**
78-
or **Post**, but you can't undo this action.
77+
you cannot edit its values. You can change the **File** method to **GET**
78+
or **POST**, but you can't undo this action.
7979
</message>
8080

81-
For example: **Get - `userid` - `#user_id#`**.
81+
For example: **GET - `userid` - `#user_id#`**.
8282

8383
The following parameter values are available.
8484

85-
| Parameter |Description |
86-
|-----------------------|-------------------------------------------------------------------------------|
87-
| `user_id` | The Box [user ID][uid]. This information is used in Popup Integrations in which user authentication is required to complete an action. You can store the Box ID in your application to enable subsequent authentication requests from the integration.|
88-
| `user_name` | The full name or email address of the Box user. Not all Box users specify their names at all times. |
89-
| `file_id` | The Box [file ID][fid]. You can use this ID to make Box API calls that affect the file. |
90-
| `file_name` | The name of the file. |
91-
| `file_extension` | The extension of the file. |
92-
| `auth_code` | The OAuth 2.0 [authorization code][code], which is generated by Box upon successful authentication. Your application must then supply this authorization code to Box in exchange for an OAuth 2.0 Access Token. An authorization header containing a valid Access Token must be included in every Box API request.
93-
| `redirect_to_box_url` | In Popup Integrations, the URL to which requests are sent by the confirmation prompt. Use this URL to redirect users to the All Files page. This parameter closes the popup panel and refreshes the All Files page to reflect any changes performed by the integration. If you do not want to add this parameter to your application, you can specify the entire URL. **Success**: `#redirect_to_box_url#&status=success&message=Your%20action%20was%20successful%2E`. **Failure**: `#redirect_to_box_url#&status=failure&message=Your%20action%20was%20unsuccessful%2E`|
85+
| Parameter | Method | Description |
86+
|-----------|--------|-------------|
87+
| `user_id` | GET, POST | The Box [user ID][uid]. This information is used in Popup Integrations in which user authentication is required to complete an action. You can store the Box ID in your application to enable subsequent authentication requests from the integration.|
88+
| `user_name` | POST | The full name or email address of the Box user. Not all Box users specify their names at all times. |
89+
| `file_id` | GET, POST | The Box [file ID][fid]. You can use this ID to make Box API calls that affect the file. |
90+
| `file_name` | POST | The name of the file. |
91+
| `file_extension` | GET, POST | The extension of the file. |
92+
| `auth_code` | GET, POST | The OAuth 2.0 [authorization code][code], which is generated by Box upon successful authentication. Your application must then supply this authorization code to Box in exchange for an OAuth 2.0 Access Token. An authorization header containing a valid Access Token must be included in every Box API request.
93+
| `redirect_to_box_url` | GET, POST | In Popup Integrations, the URL to which requests are sent by the confirmation prompt. Use this URL to redirect users to the All Files page. This parameter closes the popup panel and refreshes the All Files page to reflect any changes performed by the integration. If you do not want to add this parameter to your application, you can specify the entire URL. **Success**: `#redirect_to_box_url#&status=success&message=Your%20action%20was%20successful%2E`. **Failure**: `#redirect_to_box_url#&status=failure&message=Your%20action%20was%20unsuccessful%2E`|
9494

9595
### Integration Status
9696

‎content/guides/archives/add-content.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
rank: 1
3+
related_endpoints:
4+
- post-archives
5+
- put-files-id
6+
- put-folders-id
7+
related_resources:
8+
- archive
9+
related_guides:
10+
- archives/restore-content
11+
required_guides: []
12+
alias_paths: []
13+
---
14+
15+
# Add content to Box Archive
16+
17+
To add content to an archive, you need to create it first. If you
18+
have not done this yet, use the [Create Archive][Create Archive] endpoint.
19+
20+
## Add file or folder to archive
21+
22+
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.
23+
The `id` parameter is the ID of the file/folder you want to add to the archive.
24+
To specify the destination, use the `parent.id` [parameter][Update parent id of folder] in the request body.
25+
This can be either an ID of an archive or the ID of a folder that is inside an archive.
26+
27+
[Create Archive]: https://developer.box.com/reference/v2025.0/post-archives/
28+
[Update file]: e://put-files-id
29+
[Update parent id of file]: https://developer.box.com/reference/put-files-id/#param-parent-id
30+
[Update folder]: e://put-folders-id
31+
[Update parent id of folder]: https://developer.box.com/reference/put-folders-id/#param-parent-id

‎content/guides/archives/index.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
rank: 1
3+
related_endpoints:
4+
- post-archives
5+
- get-archives
6+
- delete-archives-id
7+
- put-files-id
8+
- put-folders-id
9+
related_resources:
10+
- archive
11+
related_guides:
12+
- archives/add-content
13+
- archives/restore-content
14+
- archives/supported-apis
15+
required_guides: []
16+
alias_paths: []
17+
---
18+
19+
# Box Archive
20+
21+
<Message type='notice'>
22+
Box Archive is available only for Enterprise Advanced accounts.
23+
</Message>
24+
25+
Box Archive allows you to create and manage archives. An archive is a folder dedicated to
26+
storing content that is redundant, outdated, or trivial. Content in an archive is owned by the enterprise,
27+
and it is not accessible to previous owner and collaborators.
28+
29+
## Archives are folders
30+
31+
Archives are a special type of folders. Box Archive APIs allow you to create, list and delete archives.
32+
However, there are other APIs that also work with archives or with content within archives.
33+
For a full list of supported APIs, see the [Supported APIs][Supported APIs] guide.
34+
35+
## Required scopes
36+
37+
Before using any of the Box Archive APIs, make sure you can access [Box Archive in Admin Console][Box Archive in Admin Console].
38+
Your Box Platform app must have the `GCM` and `Read and write all files and folders` [scopes][Scopes] enabled.
39+
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.
40+
41+
<Message type='notice'>
42+
The `GCM` scope is not available in the Developer Console and needs to be enabled by contacting customer support.
43+
</Message>
44+
45+
[Supported APIs]: g://archives/supported-apis
46+
[Box Archive in Admin Console]: https://support.box.com/hc/en-us/p/Product_Page_2023?section-id=40168863437843
47+
[Scopes]: https://developer.box.com/guides/api-calls/permissions-and-errors/scopes/

‎content/guides/archives/restore-content.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
rank: 2
3+
related_endpoints:
4+
- put-files-id
5+
- put-folders-id
6+
related_resources:
7+
- archive
8+
related_guides:
9+
- archives/add-content
10+
required_guides: []
11+
alias_paths: []
12+
---
13+
14+
# Restore content from Box Archive
15+
16+
This guide describes how to restore content that you archived by mistake.
17+
18+
## Restore file or folder from archive
19+
20+
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.
21+
The `id` parameter is the ID of the file/folder you want to restore from an archive.
22+
To specify the destination, use the `parent.id` [parameter][Update parent id of folder] in the request body.
23+
This is the ID of a folder (can be owned by any user) where you want to restore the file/folder.
24+
25+
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
26+
`parent.user_id` [parameter][Update parent user id of folder] in the request body.
27+
28+
[Update file]: e://put-files-id
29+
[Update parent id of file]: https://developer.box.com/reference/put-files-id/#param-parent-id
30+
[Update parent user id of file]: https://developer.box.com/reference/put-files-id/#param-parent-user_id
31+
[Update folder]: e://put-folders-id
32+
[Update parent id of folder]: https://developer.box.com/reference/put-folders-id/#param-parent-id
33+
[Update parent user id of folder]: https://developer.box.com/reference/put-folders-id/#param-parent-user_id

‎content/guides/archives/supported-apis.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
rank: 3
3+
related_endpoints: []
4+
related_resources:
5+
- archive
6+
related_guides: []
7+
required_guides: []
8+
alias_paths: []
9+
---
10+
11+
# Supported APIs for Box Archive
12+
13+
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.
14+
See the table below for the full list of those APIs.
15+
16+
<Message type='notice'>
17+
Those APIs require the [`GCM` scope][GCM scope] to be enabled in your application.
18+
This scope is not available in the Developer Console and needs to be enabled by contacting customer support.
19+
20+
Additionally, some of the below APIs need to be enabled by contacting customer support to properly work with Box Archive.
21+
When contacting customer support, specify the user ID you plan to use those APIs with.
22+
</Message>
23+
24+
| API Endpoint | Description |
25+
|------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
26+
| [`POST /archives`][Create archive] | Create an archive. |
27+
| [`GET /archives`][List archives] | List all archives. |
28+
| [`DELETE /archives/:id`][Delete archive] | Delete an archive. |
29+
| [`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. |
30+
| [`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. |
31+
| [`POST /files/content`][Upload file] | Upload a file to an archive or to folder within archive. Requires contacting customer support to enable. |
32+
| [`GET /files/:id/content`][Download file] | Download a file from an archive or from folder within archive. |
33+
| [`POST /zip_downloads`][Download zip] | Download a zip file of an archive or of a folder within archive. |
34+
| [`POST /folders`][Create folder within archive] | Create a folder within an archive. Requires contacting customer support to enable. |
35+
| [`GET /files/:id`][Get file details] | Get details of a file within an archive. |
36+
| [`GET /folders/:id`][Get folder details] | Get details of archive or a folder within an archive. |
37+
| [`GET /folders/:id/items`][List folder items] | List items within an archive or a folder within an archive. |
38+
| [`POST /files/:id/copy`][Copy file] | Copy a file within an archive or to another archive. |
39+
| [`POST /folders/:id/copy`][Copy folder] | Copy a folder within an archive or to another archive. |
40+
| [`POST /files/:id/metadata/:scope/:template_key`][Create metadata on file] | Create metadata instance on a file within an archive. |
41+
| [`GET /files/:id/metadata/:scope/:template_key`][View metadata on file] | View metadata instance on a file within an archive. |
42+
| [`GET /files/:id/metadata`][List metadata on file] | List all metadata instances on a file within an archive. |
43+
| [`PUT /files/:id/metadata/:scope/:template_key`][Update metadata on file] | Update metadata instance on a file within an archive. |
44+
| [`DELETE /files/:id/metadata/:scope/:template_key`][Delete metadata on file] | Delete metadata instance on a file within an archive. |
45+
| [`POST securityClassification`][Create classification label on file] | Create a classification label on a file within an archive. |
46+
| [`GET securityClassification`][View classification label on file] | View a classification label on a file within an archive. |
47+
| [`PUT securityClassification`][Update classification label on file] | Update a classification label on a file within an archive. |
48+
| [`DELETE securityClassification`][Delete classification label on file] | Delete a classification label on a file within an archive. |
49+
50+
[Create archive]: https://developer.box.com/reference/v2025.0/post-archives/
51+
[List archives]: https://developer.box.com/reference/v2025.0/get-archives/
52+
[Delete archive]: https://developer.box.com/reference/v2025.0/delete-archives-id/
53+
[Update file]: e://put-files-id
54+
[Update folder]: e://put-folders-id
55+
[Upload file]: e://post-files-content
56+
[Download file]: e://get-files-id-content
57+
[Download zip]: e://post-zip-downloads
58+
[Create folder within archive]: e://post-folders
59+
[Get file details]: e://get-files-id
60+
[Get folder details]: e://get-folders-id
61+
[List folder items]: e://get-folders-id-items
62+
[Copy file]: e://post-files-id-copy
63+
[Copy folder]: e://post-folders-id-copy
64+
[Create metadata on file]: e://post-files-id-metadata-id-id
65+
[View metadata on file]: e://get-files-id-metadata-id-id
66+
[List metadata on file]: e://get-files-id-metadata
67+
[Update metadata on file]: e://put-files-id-metadata-id-id
68+
[Delete metadata on file]: e://delete-files-id-metadata-id-id
69+
[Create classification label on file]: e://post-files-id-metadata-enterprise-securityClassification-6VMVochwUWo
70+
[View classification label on file]: e://get-files-id-metadata-enterprise-securityClassification-6VMVochwUWo
71+
[Update classification label on file]: e://put-files-id-metadata-enterprise-securityClassification-6VMVochwUWo
72+
[Delete classification label on file]: e://delete-files-id-metadata-enterprise-securityClassification-6VMVochwUWo
73+
[GCM scope]: https://developer.box.com/guides/api-calls/permissions-and-errors/scopes/#global-content-manager-gcm

0 commit comments

Comments
 (0)