[Box Platform](https://box.dev) provides functionality to provide access to content stored within [Box](https://box.com). It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention poli
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.box.com/2.0
auth: o a u t h 2
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
[Box Platform](https://box.dev) provides functionality to provide access to content stored within [Box](https://box.com). It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention policies.
| method | path | what the vendor says it does |
|---|---|---|
GET | /authorize | Authorize user Authorize a user by sending them through the [Box](https://box.com) website and request their p |
GET | /collaboration_whitelist_entries | List allowed collaboration domains Returns the list domains that have been deemed safe to create collaboration |
POST | /collaboration_whitelist_entries | Add domain to list of allowed collaboration domains Creates a new entry in the list of allowed domains to allo |
GET | /collaboration_whitelist_entries/{collaboration_whitelist_entry_id} | Get allowed collaboration domain Returns a domain that has been deemed safe to create collaborations for withi |
DELETE | /collaboration_whitelist_entries/{collaboration_whitelist_entry_id} | Remove domain from list of allowed collaboration domains Removes a domain from the list of domains that have b |
GET | /collaboration_whitelist_exempt_targets | List users exempt from collaboration domain restrictions Returns a list of users who have been exempt from the |
POST | /collaboration_whitelist_exempt_targets | Create user exemption from collaboration domain restrictions Exempts a user from the restrictions set out by t |
GET | /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id} | Get user exempt from collaboration domain restrictions Returns a users who has been exempt from the collaborat |
DELETE | /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id} | Remove user from list of users exempt from domain restrictions Removes a user's exemption from the restriction |
GET | /collaborations | List pending collaborations Retrieves all pending collaboration invites for this user. Collaborations (List) |
POST | /collaborations | Create collaboration Adds a collaboration for a single user or a single group to a file or folder. Collaborat |
GET | /collaborations/{collaboration_id} | Get collaboration Retrieves a single collaboration. Collaborations |
PUT | /collaborations/{collaboration_id} | Update collaboration Updates a collaboration. Can be used to change the owner of an item, or to accept collabo |
DELETE | /collaborations/{collaboration_id} | Remove collaboration Deletes a single collaboration. Collaborations |
GET | /collections | List all collections Retrieves all collections for a given user. Currently, only the `favorites` collection i |
GET | /collections/{collection_id}/items | List collection items Retrieves the files and/or folders contained within this collection. Collections |
POST | /comments | Create comment Adds a comment by the user to a specific file, or as a reply to an other comment. Comments |
GET | /comments/{comment_id} | Get comment Retrieves the message and metadata for a specific comment, as well as information on the user who |
PUT | /comments/{comment_id} | Update comment Update the message of a comment. Comments |
DELETE | /comments/{comment_id} | Remove comment Permanently deletes a comment. Comments |
GET | /device_pinners/{device_pinner_id} | Get device pin Retrieves information about an individual device pin. Device pinners |
DELETE | /device_pinners/{device_pinner_id} | Remove device pin Deletes an individual device pin. Device pinners |
GET | /enterprises/{enterprise_id}/device_pinners | List enterprise device pins Retrieves all the device pins within an enterprise. The user must have admin priv |
GET | /events | List user and enterprise events Returns up to a year of past events for a given user or for the entire enterpr |
GET | /file_requests/{file_request_id} | Get file request Retrieves the information about a file request. File requests |
PUT | /file_requests/{file_request_id} | Update file request Updates a file request. This can be used to activate or deactivate a file request. File re |
DELETE | /file_requests/{file_request_id} | Delete file request Deletes a file request permanently. File requests |
POST | /file_requests/{file_request_id}/copy | Copy file request Copies an existing file request that is already present on one folder, and applies it to ano |
GET | /file_version_legal_holds | List file version legal holds Get a list of file versions on legal hold for a legal hold assignment. Due to o |
GET | /file_version_legal_holds/{file_version_legal_hold_id} | Get file version legal hold Retrieves information about the legal hold policies assigned to a file version. Fi |
GET | /file_version_retentions | List file version retentions Retrieves all file version retentions for the given enterprise. File version rete |
GET | /file_version_retentions/{file_version_retention_id} | Get retention on file Returns information about a file version retention. File version retentions |
POST | /files/content | Upload file Uploads a small file to Box. For file sizes over 50MB we recommend using the Chunk Upload APIs. # |
POST | /files/upload_sessions | Create upload session Creates an upload session for a new file. Uploads (Chunked) |
GET | /files/upload_sessions/{upload_session_id} | Get upload session Return information about an upload session. Uploads (Chunked) |
PUT | /files/upload_sessions/{upload_session_id} | Upload part of file Updates a chunk of an upload session for a file. Uploads (Chunked) |
DELETE | /files/upload_sessions/{upload_session_id} | Remove upload session Abort an upload session and discard all data uploaded. This cannot be reversed. Uploads |
POST | /files/upload_sessions/{upload_session_id}/commit | Commit upload session Close an upload session and create a file from the uploaded chunks. Uploads (Chunked) |
GET | /files/upload_sessions/{upload_session_id}/parts | List parts Return a list of the chunks uploaded to the upload session so far. Uploads (Chunked) |
GET | /files/{file_id} | Get file information Retrieves the details about a file. Files |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://opensource.box.com/box-openapi/openapi.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.