Manage Applications

    Upload Session

    An upload session for chunk uploading a file.

    string
    11446498

    The unique identifier for this object

    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.

    A list of endpoints for this session.

    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.

    string
    upload_session

    Value is always "upload_session"

    Response Example

    {
      "id": 11446498,
      "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": {
        "upload_part": "https://upload.box.com/api/2.0/files/upload_sessions/D5E3F7A",
        "commit": "https://upload.box.com/api/2.0/files/upload_sessions/D5E3F7A/commit",
        "abort": "https://upload.box.com/api/2.0/files/upload_sessions/D5E3F7A",
        "list_parts": "https://upload.box.com/api/2.0/files/upload_sessions/D5E3F7A/parts",
        "status": "https://upload.box.com/api/2.0/files/upload_sessions/D5E3F7A",
        "log_event": "https://upload.box.com/api/2.0/files/upload_sessions/D5E3F7A/log"
      }
    }