Skip to main content
POST
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 create a new shuttle path mapping.

job_id
string
required

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

Example:

"6a3ba68e810d9156194530a1"

source
Shuttle path mapping account location input · object
required

The source location to migrate from.

is_path_skipped
boolean
default:false

Whether this source path should be skipped during the migration. Defaults to false.

Example:

false

target
Shuttle path mapping account location target input · object

The destination location to migrate to. Omit or set to null when the source path is skipped.

Example:

Response

Returns the newly created shuttle path mapping.

A standard representation of a shuttle path mapping. A path mapping connects a source location on the migrated system to a destination in Box, or marks the source path as skipped.

id
string
required

The unique identifier for the shuttle path mapping.

Example:

"6a3ba7a24ea17bc9461eeacd"

type
enum<string>
required

The value will always be shuttle_path_mapping.

Available options:
shuttle_path_mapping
Example:

"shuttle_path_mapping"

job_id
string
required

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

Example:

"6a3ba68e810d9156194530a1"

is_path_skipped
boolean
required

Whether this source path is skipped during the migration.

Example:

false

source
Shuttle path mapping account location · object
required

The source location being mapped.

target
Shuttle path mapping account location · object

The destination location. null when the source path is skipped or the job has no destination, such as an analysis job.

Example:
Last modified on October 26, 2026