新しい Forward Memory Store を作成します。
Memory Store コンテナを作成します。Store のみを作成するか、省略可能な
直接マウントにもMemory Store のマウントと同じルールが適用されます。Store はユーザーが作成した active 状態の Store である必要があります。権限は常に
Store のみ作成する場合は
HTTP 200 OK
Memory Store オブジェクトを返します。
mount フィールドを指定して、作成後に (identity, template) に直接マウントできます。
パス
POST /api/v1/forward/memory_stores
ヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
Authorization | はい | Bearer <PAT or admin SAT> |
Idempotency-Key | はい | 作成リクエストの冪等性キー。同じキーは同じリクエストボディでのみ再利用できます。省略すると 400 が返されます。 |
Content-Type | はい | application/json |
リクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | 空でない表示名。改行 \n、復帰 \r、タブ \t を除く非表示制御文字(U+0000~U+001F、U+007F)は使用できません。 |
description | string | いいえ | 自由記述の説明。非表示制御文字は使用できません。 |
metadata | object | いいえ | 値が文字列のキー・バリューメタデータ。最大 15 キー、キーは 1~64 文字、値は 512 文字以下です。created_by は Forward の予約キーで、サーバーが "forward" を設定します。呼び出し元が指定すると 400 invalid_request_error が返されます。Store メタデータの制約を参照してください。 |
mount | object | いいえ | 作成後に設定するマウント関係。指定する場合は identity_id と template_id の両方が必要です。 |
mount.identity_id | string | 条件付き | Identity ID(idn_...)。mount を指定する場合は必須。 |
mount.template_id | string | 条件付き | Template ID(tmpl_...)。mount を指定する場合は必須。 |
read_only で、同じ (identity, template) に明示的にマウントできる Store は最大 10 個です。作成した Store は system_managed=false のままで、システムの Default Memory Store にはなりません。
リクエスト例
mount を省略します。
レスポンス例
HTTP 200 OK
mount を指定すると、レスポンスを返す前にマウントが完了するため、binding_info.identity_template_count には新しいマウントが含まれます。同じ Idempotency-Key とリクエストボディで再試行すると、同じ Store のマウント処理を継続し、Store やマウント関係を重複して作成しません。
レスポンス
Memory Store オブジェクトを返します。
エラー
| HTTP | Type | 発生条件 |
|---|---|---|
| 400 | invalid_request_error | リクエストボディが無効です。name がないか制御文字を含む、metadata が 15 キーを超えるか created_by を含む、Idempotency-Key がない、mount のいずれかの ID がない、または明示的なマウント数が上限の 10 に達しています。 |
| 401 | authentication_error | 認証トークンがないか無効です。 |
| 403 | permission_error | 呼び出し元にリソースの作成権限がありません。 |
| 404 | not_found_error | mount で指定した Identity または Template が存在しないか、呼び出し元から参照できません。 |
| 409 | conflict_error | 同じ Idempotency-Key が異なるリクエストボディで使用されたか、作成処理の復旧に手動対応が必要です。 |
| 500/502/503 | api_error | Forward または依存サービスでエラーが発生しました。 |

