Box Developer Documentation
Log in
Latest version

Get upload session

get
https://{box-upload-server}/api/2.0
/files/upload_sessions/:upload_session_id

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Return information about an upload session.

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

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
D5E3F7A

The ID of the upload session.

Response

application/jsonUpload session

Returns an upload session object.

application/jsonClient error

An unexpected client error.

get
Get upload session
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X GET "https://upload.box.com/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.chunkedUploads.getFileUploadSessionById(uploadSessionId);
Python Gen
client.chunked_uploads.get_file_upload_session_by_id(upload_session_id)
.NET Gen
await client.ChunkedUploads.GetFileUploadSessionByIdAsync(uploadSessionId: uploadSessionId);
Swift Gen (Beta)
try await client.chunkedUploads.getFileUploadSessionById(uploadSessionId: uploadSessionId)
Java
BoxFileUploadSession.Info updatedSessionInfo = session.getStatus();
Node
// Get info about upload session 93D9A837B45F
client.files.getUploadSessionStatus('93D9A837B45F', callback);

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
}