Box Developerドキュメント
最新バージョン

Shieldリストを作成

post
https://api.box.com/2.0
/shield_lists

Shieldリストを作成します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエストヘッダー

stringヘッダー内必須

Version header

次の値に固定: 2025.0

リクエスト本文

このShieldリストの要素の種類を指定し、要素自体を含めます。公開APIで統合のShieldリストを更新することはできません。

string本文内省略可能
"A list of things that are shielded"

Shieldリストの説明: 省略可。

string本文内必須
"My Shield List"

Shieldリストの名前。

レスポンス

application/jsonShieldリスト

Shieldリストオブジェクトを返します。

この名前のShieldリストがすでに存在します。

post
Shieldリストを作成
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

TypeScript Gen
await client.shieldLists.createShieldListV2025R0({
  name: shieldListCountryName,
  description: 'A list of things that are shielded',
  content: new ShieldListContentCountryV2025R0({
    type: 'country' as ShieldListContentCountryV2025R0TypeField,
    countryCodes: ['US', 'PL'],
  }),
} satisfies ShieldListsCreateV2025R0);
Python Gen
client.shield_lists.create_shield_list_v2025_r0(
    shield_list_country_name,
    ShieldListContentCountryV2025R0(
        type=ShieldListContentCountryV2025R0TypeField.COUNTRY,
        country_codes=["US", "PL"],
    ),
    description="A list of things that are shielded",
)
.NET Gen
await client.ShieldLists.CreateShieldListV2025R0Async(requestBody: new ShieldListsCreateV2025R0(name: shieldListCountryName, content: new ShieldListContentCountryV2025R0(type: ShieldListContentCountryV2025R0TypeField.Country, countryCodes: Array.AsReadOnly(new [] {"US","PL"}))) { Description = "A list of things that are shielded" });

レスポンスの例

{
  "id": "90fb0e17-c332-40ed-b4f9-fa8908fbbb24",
  "type": "shield_list",
  "content": {
    "type": "country",
    "country_codes": [
      "US",
      "PL"
    ]
  },
  "created_at": "2025-01-13T15:31:01.896Z",
  "description": "A list of things that are shielded",
  "enterprise": {
    "id": "1910967",
    "type": "enterprise"
  },
  "name": "Shield List Name",
  "updated_at": "2025-01-13T15:31:01.896Z"
}