BObox
Uploads (Chunked)

Get upload session

Changed on

Return information about an upload session.

The actual endpoint URL is returned by the Create upload session endpoint.

get/files/upload_sessions/{upload_session_id}

Request

  • Base URL
    https://upload.box.com/api/2.0
  • URL
    https://upload.box.com/api/2.0/files/upload_sessions/{upload_session_id}
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Path parameters

upload_session_idstring required

The ID of the upload session.

Response

Returns an upload session object.

idstring

The unique identifier for this session.

type'upload_session'

The value will always be upload_session.

session_expires_atstring date-time

The date and time when this session expires.

part_sizeinteger

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

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

total_partsinteger

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

num_parts_processedinteger

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

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

Example response

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

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • info

      added the optional property // to the response with the status