Create shuttle report

{
  "id": "6a3ba8d14f2c91e8370b4d12",
  "type": "shuttle_report",
  "run_id": "6a3ba68e810d9156194530a1:42",
  "status": "complete",
  "format": "xlsx",
  "output": {
    "id": "12345678",
    "type": "file"
  },
  "completed_at": "2026-03-15T06:36:12Z",
  "sections": [
    "event_log",
    "transfer_overview"
  ],
  "users_scope": "migrated",
  "created_at": "2026-03-15T06:35:00Z"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

POST

shuttle_reports

{
  "id": "6a3ba8d14f2c91e8370b4d12",
  "type": "shuttle_report",
  "run_id": "6a3ba68e810d9156194530a1:42",
  "status": "complete",
  "format": "xlsx",
  "output": {
    "id": "12345678",
    "type": "file"
  },
  "completed_at": "2026-03-15T06:36:12Z",
  "sections": [
    "event_log",
    "transfer_overview"
  ],
  "users_scope": "migrated",
  "created_at": "2026-03-15T06:35:00Z"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

Learn more about Box SDK versioning strategy.

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

Body

application/json

The request body used to generate a report for a shuttle run. Generation is asynchronous: the created report is returned immediately in pending or processing status. Poll GET /shuttle_reports/{shuttle_report_id} while status is pending or processing. Stop when status is complete, failed, canceled, or unknown. Repeating this request with the same parameters reuses the existing report instead of creating a duplicate.

run_id

string

required

The unique identifier of the shuttle run to generate a report for.

Example:

"6a3ba68e810d9156194530a1:42"

format

enum<string>

required

The output file format of the report.

Available options:

xlsx,

csv

Example:

"xlsx"

sections

string[]

required

The sections to include in the report. Must be a non-empty subset of the run's available_report_sections. 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.

Minimum array length: 1

A section to include in the report.

Example:

["event_log", "transfer_overview"]

users_scope

enum<string>

default:migrated

Which users to include in user-related report sections. Defaults to migrated when omitted.

Available options:

migrated,

all

Example:

"migrated"

Response

The report was accepted for generation. Returns the shuttle report; generation continues asynchronously. Repeating this request with the same parameters reuses the existing report instead of creating a duplicate.

A report generated asynchronously for a shuttle job run. Keep polling while status is pending or processing. Stop when status is complete, failed, canceled, or unknown. The generated Box file or folder is null until generation finishes.

string

required

The unique identifier for the shuttle report.

Example:

"6a3ba8d14f2c91e8370b4d12"

type

enum<string>

required

The value will always be shuttle_report.

Available options:

shuttle_report

Example:

"shuttle_report"

run_id

string

required

The unique identifier of the shuttle run this report was generated for.

Example:

"6a3ba68e810d9156194530a1:42"

status

string

required

The generation status of the report. This is an open string whose set of values is expected to grow; the currently documented values include pending, processing, complete, failed, canceled, and unknown. Keep polling pending and processing. Stop on complete, failed, canceled, and unknown. Treat any value that is not recognized the same as unknown: do not fail parsing, and do not keep polling.

Example:

"complete"

format

enum<string>

required

The output file format of the report.

Available options:

xlsx,

csv

Example:

"xlsx"

output

Shuttle report output · object

required

The generated Box file or folder. Always present; null until status is complete.

Shuttle report output
OpenAPI 3.0 null schema type

Show child attributes

Example:

{ "id": "12345678", "type": "file" }

completed_at

string<date-time> | null

required

When report generation finished. Always present; null while generation is still in progress.

Example:

"2026-03-15T06:36:12Z"

sections

string[]

The sections included in the report. Echoes the sections requested on create. 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. Omitted on older reports that have no stored section list. New reports always include this field.

Minimum array length: 1

A section included in the report.

Example:

["event_log", "transfer_overview"]

users_scope

enum<string>

Which users are included in user-related report sections.

Available options:

migrated,

all

Example:

"migrated"

created_at

string<date-time>

When report generation was requested.

Example:

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

Last modified on October 26, 2026

API reference

v2025.0

v2026.0

Authorizations

Headers

Body

Response