ワークスペースシークレットを作成または更新する

PUT /api/v1/projects/{id}/workspaces/{workspace_id}/secrets/{name}
Bearer 認証

シークレット名を検証し、ワークスペースにスコープが設定された ECP へのアップサートリクエストをプロキシします。プロジェクトスコープは ルート ID パス パラメーターによって保持され、 組織はそのプロジェクトから派生します。セッション JWT またはプロジェクトスコープのAPIキーのいずれかを受け入れるため、CI/CD はインタラクティブなログインなしで短期間のビルド認証情報をシードできます。 APIキーは、パスにある名前のプロジェクトにスコープ設定する必要があります。呼び出し元には、そのプロジェクトに対する配置管理権限（PROJECT_OWNER、AGENT_DELEOPER、エージェント エンジン ネイティブ プロジェクトの ORM_ADMIN、または SYSTEM_ADMIN）が必要です。

path パラメータ

  • id string 必須

    プロジェクトID

  • Workspace_id string 必須

    ワークスペースID

  • name string 必須

    シークレット名（大文字の env-var 形式）

application/ JSON

body 必須

秘密の値と任意の説明

  • 説明 string
  • 価値 string
  • value_unchanged ブール値

    ValueUnchanged は、既存のシークレットの説明のみを編集する呼び出し元によって明示的に設定される必要があります。これは値を空にすることができるものです。設定されていない場合、空の値は常に拒否されます。呼び出し元は、誤って（一時的なバグや環境変数の設定が解除された場合など）、古い値を暗黙的に残すのではなく、クリアされた 400 が取得されます。

応答

  • 406

    サポートされていないAPIバージョンまたは不正な API バージョン、選択した公開契約で利用できない操作、または受け入れができない表現（サポートされていないメディアタイプのパラメーター、または除外された SSE を含む）。既存の認証、認可、およびレート制限の失敗が優先されます。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエート エラーでは、このフィールドは出力されません。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        検証に失敗したフィールド。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト

        フィールドとその検証の失敗。

        • 説明 string 必須

          人間が判読できる検証の失敗。

        • フィールド string 必須

          無効なリクエストフィールドの名前またはパス。

    • 詳細 string 必須

      人間が判読できるエラーの詳細。

    • エラー integer 必須

      HTTP status code.

    • errorCode string 必須

      マシンが判読できるエラー コード。

    • パラメーター array[string]

      エラーに関連付けられたリクエスト パラメータ名。該当しない場合は省略します。

    • 理由 string 必須

      HTTPステータス理由フレーズ。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエート エラーでは、このフィールドは出力されません。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        検証に失敗したフィールド。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト

        フィールドとその検証の失敗。

        • 説明 string 必須

          人間が判読できる検証の失敗。

        • フィールド string 必須

          無効なリクエストフィールドの名前またはパス。

    • 詳細 string 必須

      人間が判読できるエラーの詳細。

    • エラー integer 必須

      HTTP status code.

    • errorCode string 必須

      マシンが判読できるエラー コード。

    • パラメーター array[string]

      エラーに関連付けられたリクエスト パラメータ名。該当しない場合は省略します。

    • 理由 string 必須

      HTTPステータス理由フレーズ。
  • 200

    OK
  • 400

    無効なリクエスト

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 403

    Forbidden

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 404

    見つかりません

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 413

    エンティティが大きすぎるリクエスト

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 429

    リクエストが多すぎる

    ヘッダー属性を非表示 ヘッダー属性を表示
    • 再試行後 string

      再試行する前に待機する秒数

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 502

    バード ゲートウェイ

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 503

    サービスは利用できません

    ヘッダー属性を非表示 ヘッダー属性を表示
    • 再試行後 string

      再試行する前に待機する秒数

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
PUT /api/v1/projects/{id}/workspaces/{workspace_id}/secrets/{name} 
curl \
 --request PUT 'https://agentengine.mongodb.com/api/v1/projects/{id}/workspaces/{workspace_id}/secrets/{name}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "description": "string",
  "value": "string",
  "value_unchanged": true
}'
リクエスト例 
{
  "description": "string",
  "value": "string",
  "value_unchanged": true
}
応答の例（406） 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
応答の例（406） 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
応答の例（200） 
{}
応答の例（200） 
{}
応答の例（400） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（400） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（403） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（403） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（404） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（404） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（413） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（413） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（429） 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（429） 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（502） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（502） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（503） 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（503） 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}