Get shuttle run by ID

{ "id": "6a3ba68e810d9156194530a1:42", "type": "shuttle_run", "job_id": "6a3ba68e810d9156194530a1", "run_mode": "transfer", "state": "completed", "started_at": "2026-03-15T02:00:00Z", "ended_at": "2026-03-15T06:30:00Z", "duration_seconds": 16200, "stats": { "bytes_sent": 1073741824, "files_sent": 4200, "folders_created": 350, "is_estimated": false }, "created_by": { "id": "11446498", "type": "user" }, "available_report_sections": [ "event_log", "files_and_folders" ] }

{ "type": "error", "status": 400, "code": "item_name_invalid", "message": "Method Not Allowed", "context_info": { "message": "Something went wrong" }, "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/", "request_id": "abcdef123456" }

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

box-version

enum<string>

required

Version header.

Available options:

2026.0

Path Parameters

shuttle_run_id

string

required

The unique identifier for the shuttle run, in the form {job_id}:{run_number}.

Response

Returns the shuttle run.

A historical instance of a shuttle job run. A run is created each time a job is started. Run IDs have the form {job_id}:{run_number}.

string

required

The unique identifier for the shuttle run, in the form {job_id}:{run_number}.

Example:

"6a3ba68e810d9156194530a1:42"

type

enum<string>

required

The value will always be shuttle_run.

Available options:

shuttle_run

Example:

"shuttle_run"

job_id

string

required

The unique identifier of the shuttle job this run belongs to.

Example:

"6a3ba68e810d9156194530a1"

run_mode

string

required

The mode the run was started in. This is an open string whose set of values is expected to grow; the currently documented values include transfer, simulation, analysis, scan, and unknown. Clients should treat any value they do not recognize as unknown.

Example:

"transfer"

state

string

required

The current state of the shuttle run. This is an open string whose set of values is expected to grow; the currently documented values include running, stopping, completed, completed_with_errors, stopped, failed, timed_out, and unknown. Clients should treat any value they do not recognize as unknown.

Example:

"completed"

started_at

string<date-time>

When the run started.

Example:

"2026-03-15T02:00:00Z"

ended_at

string<date-time> | null

When the run ended. null while the run is still in progress.

Example:

"2026-03-15T06:30:00Z"

duration_seconds

integer<int64> | null

Total duration of the run in seconds. null while the run is still in progress.

Example:

16200

stats

object

Transfer statistics collected during the run.

Show child attributes

created_by

User (Base) · object

The user who started the run. null for schedule- or system-initiated runs.

User (Base)
OpenAPI 3.0 null schema type

Show child attributes

Example:

{ "id": "11446498", "type": "user" }

available_report_sections

string[]

Report sections that can be requested for this run. This is an open list whose set of values is expected to grow; the currently documented values include files_and_folders, event_log, transfer_overview, source_users, target_users, source_collaborators, target_collaborators, source_collaborations, and target_collaborations.

A report section available for this run.

Example:

["event_log", "files_and_folders"]

API reference

v2025.0

v2026.0

Authorizations

Headers

Path Parameters

Response