Upload session

An upload session for chunk uploading a file.

id string

exampleF971964745A5CD0C001BBE4E58196BFD

The unique identifier for this session

num_parts_processed integer / int32

example455

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.

part_size integer / int64

example1024

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.

session_endpoints object

A list of endpoints for this session.

session_endpoints.abort string

examplehttps://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD

The URL for used to abort the session.

session_endpoints.commit string

examplehttps://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit

The URL used to commit the file

session_endpoints.list_parts string

examplehttps://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/parts

The URL users to list all parts.

session_endpoints.log_event string

examplehttps://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/log

The URL used to get the upload log from.

session_endpoints.status string

examplehttps://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD

The URL used to get the status of the upload.

session_endpoints.upload_part string

examplehttps://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD

The URL to upload parts to

session_expires_at string / date-time

example2012-12-12T10:53:43-08:00

The date and time when this session expires.

total_parts integer / int32

example1000

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

type string

exampleupload_session

Value is always upload_session

Response Example

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