メインコンテンツへスキップ
POST
「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

Authorization
string
header
必須

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

ヘッダー

box-version
enum<string>
必須

Version header.

利用可能なオプション:
2026.0

ボディ

application/json

Shuttleシステムを作成するためのリクエスト本文。公開APIを使用して作成できるのはWindowsエージェントシステムのみであるため、system_typeはwindowsでなければなりません。

name
string
必須

新しいShuttleシステムの表示名。

Minimum string length: 1
例:

"NYC File Server"

system_type
enum<string>
必須

新しいShuttleシステムの公開システムタイプ識別子。現在、公開APIではwindowsのみがサポートされています。

利用可能なオプション:
windows
例:

"windows"

レスポンス

新しく作成されたShuttleシステムを返します。

ShuttleシステムのStandard版の表示。Shuttleシステムは、Shuttleがコンテンツを移行する際の移行元または移行先と、その現在の接続状態を表します。

id
string
必須

Shuttleシステムの一意の識別子。

例:

"6a315c0754833bfc5df067bf"

type
enum<string>
必須

値は常にshuttle_systemになります。

利用可能なオプション:
shuttle_system
例:

"shuttle_system"

name
string
必須

Shuttleシステムの表示名。

例:

"BoxProd"

system_type
string
必須

このシステムが表す移行元または移行先の種類を識別します。たとえば、box、windows、sharepoint、amazon_s3などです。随時新しいシステムタイプが追加されるため、クライアントはこれを固定された値の集合として扱わず、認識できない値も許容する必要があります。

例:

"box"

state
enum<string>
必須

Shuttleシステムの現在の接続状態。

利用可能なオプション:
connected,
disconnected,
unknown
例:

"connected"

label
string

サーバーによって算出される、システムの表示ラベル。

例:

"Box (Production)"

最終更新日 2026年11月4日