The access token received from the authorization server in the OAuth 2.0 flow.
Available options:
2026.0
The request body for creating a shuttle system. Only Windows agent systems can be created through the public API, so system_type must be windows.
The display name for the new shuttle system.
Minimum string length: 1
The public system type identifier for the new shuttle system. Only windows is currently supported through the public API.
Available options:
windows
Returns the newly created shuttle system.
A standard representation of a shuttle system. A shuttle system describes a source or destination that Shuttle can migrate content to or from, along with its current connection state.
The unique identifier for the shuttle system.
Example:"6a315c0754833bfc5df067bf"
The value will always be shuttle_system.
Available options:
shuttle_system
The display name of the shuttle system.
Identifies the kind of source or destination this system represents, for example box, windows, sharepoint, or amazon_s3. New system types are added over time, so clients must tolerate values they do not recognize rather than treating this as a fixed set.
The current connection state of the shuttle system.
Available options:
connected,
disconnected,
unknown
A server-computed display label for the system.
Last modified on October 26, 2026