Create shuttle path mapping
Creates a path mapping that connects a source location on the migrated system to a destination in Box for the given shuttle job.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Version header.
2026.0 Body
The request body used to create a new shuttle path mapping.
The unique identifier of the shuttle job this mapping belongs to.
"6a3ba68e810d9156194530a1"
The source location to migrate from.
- Shuttle path mapping account location input
Whether this source path should be skipped during the migration. Defaults to false.
false
The destination location to migrate to. Omit or set to null when the source path is skipped.
- Shuttle path mapping account location target input
- OpenAPI 3.0 null schema type
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.
The unique identifier for the shuttle path mapping.
"6a3ba7a24ea17bc9461eeacd"
The value will always be shuttle_path_mapping.
shuttle_path_mapping "shuttle_path_mapping"
The unique identifier of the shuttle job this mapping belongs to.
"6a3ba68e810d9156194530a1"
Whether this source path is skipped during the migration.
false
The source location being mapped.
- Shuttle path mapping account location
The destination location. null when the source path is skipped or the job has no destination, such as an analysis job.
- Shuttle path mapping account location
- OpenAPI 3.0 null schema type
