Skip to main content
API version 2024.0 An upload session for chunk uploading a file.
​
id
string
example: F971964745A5CD0C001BBE4E58196BFDThe unique identifier for this session.
​
type
string
example: upload_sessionThe value will always be upload_session.Value is always upload_session
​
num_parts_processed
integer(int32)
example: 455The 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.
​
part_size
integer(int64)
example: 1024The 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.
​
session_endpoints
object
A list of endpoints for this session.
​
session_expires_at
string(date-time)
example: 2012-12-12T10:53:43-08:00The date and time when this session expires.
​
total_parts
integer(int32)
example: 1000The total number of parts expected in this upload session, as determined by the file size and part size.
{
  "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
}