使用可能なサンドボックスエンドポイント

最終更新日： 2026年5月24日

トピック：
Sandboxes

作成対象：

Developer

NOTE

サンドボックス APIで提供される他のエンドポイントとは異なり、このエンドポイントは、サンドボックス管理アクセス権限を持たないユーザーを含むすべてのユーザーが使用できます。

使用可能なサンドボックスエンドポイントにGET リクエストを実行することで、現在のユーザーが使用できるサンドボックスを一覧表示できます。

API 形式

GET /{QUERY_PARAMS}

パラメーター

説明

{QUERY_PARAMS}

結果をフィルタリングする条件となるクエリパラメーター（オプション）。使用可能なパラメーターのリストについては、付録ドキュメントを参照してください。

リクエスト

curl -X GET \
  https://platform.adobe.io/data/foundation/sandbox-management/?limit=3&offset=1 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}'

応答

応答が成功すると、name、title、state、typeなどの詳細を含め、現在のユーザーが利用できるサンドボックスのリストが返されます。

{
    "sandboxes": [
        {
            "name": "prod",
            "title": "Production",
            "state": "active",
            "type": "production",
            "region": "VA7",
            "isDefault": true,
            "eTag": 2,
            "createdDate": "2019-09-04 04:57:24",
            "lastModifiedDate": "2019-09-04 04:57:24",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        },
        {
            "name": "dev",
            "title": "Development",
            "state": "active",
            "type": "development",
            "region": "VA7",
            "isDefault": false,
            "eTag": 1,
            "createdDate": "2019-09-03 22:27:48",
            "lastModifiedDate": "2019-09-03 22:27:48",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        },
        {
            "name": "stage",
            "title": "Staging",
            "state": "active",
            "type": "development",
            "region": "VA7",
            "isDefault": false,
            "eTag": 1,
            "createdDate": "2019-09-03 22:27:48",
            "lastModifiedDate": "2019-09-03 22:27:48",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        }
    ],
    "_page": {
        "limit": 3,
        "count": 1
    },
    "_links": {
        "page": {
            "href": "https://platform.adobe.io:443/data/foundation/sandbox-management/?limit={limit}&offset={offset}",
            "templated": true
        }
    }
}

プロパティ

説明

name

サンドボックスの名前。 API 呼び出しで参照目的に使用されます。

title

サンドボックスの表示名。

state

サンドボックスの現在の処理状態。サンドボックスの状態は、次のいずれかになります。

creating: サンドボックスは作成されましたが、まだシステムによってプロビジョニングされています。
active: サンドボックスが作成され、アクティブになっています。
failed: エラーが発生したため、サンドボックスをシステムでプロビジョニングできず、無効になっています。
deleted: サンドボックスは手動で無効になっています。

type

サンドボックスタイプ（「開発」または「本番」）。

isDefault

このサンドボックスが組織のデフォルトの実稼動サンドボックスであるかどうかを示すブール値プロパティ。

eTag

サンドボックスの特定のバージョンの識別子。バージョン管理とキャッシュの効率化に使用され、この値はサンドボックスに変更が追加されるたびに更新されます。

recommendation-more-help

experience-platform-help-sandboxes