Box Developer Documentation
Log in

Upload session

This resource is used by enpoints in the version 2024.0. For more details, see Box API versioning.

An upload session for chunk uploading a file.

string
F971964745A5CD0C001BBE4E58196BFD

The unique identifier for this session

string
upload_session

upload_session

Value is always upload_session

integer (int32)
455

The number of parts that have been uploaded and processed by the server. This starts at 0.

When committing a file files, inspecting this property can provide insight if all parts have been uploaded correctly.

integer (int64)
1024

The size in bytes that must be used for all parts of of the upload.

Only the last part is allowed to be of a smaller size.

object

A list of endpoints for this session.

string
https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD

The URL for used to abort the session.

string
https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit

The URL used to commit the file

string
https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/parts

The URL users to list all parts.

string
https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/log

The URL used to get the upload log from.

string
https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD

The URL used to get the status of the upload.

string
https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD

The URL to upload parts to

string (date-time)
2012-12-12T10:53:43-08:00

The date and time when this session expires.

integer (int32)
1000

The total number of parts expected in this upload session, as determined by the file size and part size.

Response Example

{
  "id": "F971964745A5CD0C001BBE4E58196BFD",
  "type": "upload_session",
  "num_parts_processed": 455,
  "part_size": 1024,
  "session_endpoints": {
    "abort": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD",
    "commit": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit",
    "list_parts": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/parts",
    "log_event": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/log",
    "status": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD",
    "upload_part": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD"
  },
  "session_expires_at": "2012-12-12T10:53:43-08:00",
  "total_parts": 1000
}