Shuttleシステムを更新 - Box Dev Docs

{
  "id": "6a315c0754833bfc5df067bf",
  "type": "shuttle_system",
  "name": "BoxProd",
  "system_type": "box",
  "state": "connected",
  "label": "Box (Production)"
}

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

PUT

/

shuttle_systems

/

{shuttle_system_id}

{
  "id": "6a315c0754833bfc5df067bf",
  "type": "shuttle_system",
  "name": "BoxProd",
  "system_type": "box",
  "state": "connected",
  "label": "Box (Production)"
}

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

「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

パスパラメータ

shuttle_system_id

string

必須

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

ボディ

application/json

Shuttleシステムを更新するためのリクエスト本文。指定されたフィールドのみが変更されます。

name

string

Shuttleシステムの更新後の表示名。

Minimum string length: 1

例:

"NYC File Server (Primary)"

レスポンス

更新された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日