API キーを一覧表示する

GET /api/v1/projects/{id}/keys

Bearer 認証

プロジェクトのすべてのAPIキーを一覧表示します。プロジェクトスコープはルート ID パスパラメーターによって保持され、組織はそのプロジェクトから派生します。

path パラメータ

id string 必須

プロジェクトID

クエリパラメータ

include_inactive string

非アクティブなキーを含めます

応答

406

application/ JSON

application/ JSON アプリケーション/vnd.agent- engine-2026-09-20-preview+json

サポートされていない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

アプリケーション/vnd.agent- engine-2026-09-20-preview+json

アプリケーション/vnd.agent- engine-2026-09-20-preview+json application/ JSON

OK
応答属性の非表示応答属性の表示オブジェクト
- count integer
- キー array[オブジェクト]
  
  キー属性を非表示にするキー属性を表示するオブジェクト
  
  created_at string
  
  created_by string
  
  このトークンを作成したユーザー
  
  説明 string
  
  人間が判読できる説明
  
  expires_at string
  
  id string
  
  is_active ブール値
  
  last_used_at string
  
  使用状況の追跡
  
  org_id string
  
  このトークンが属する組織
  
  project_id string
  
  このトークンが属するプロジェクト
  
  revoked_at string
  
  revoked_by string
  
  token_prefix string
  
  識別用の限界のあるルックアップのプレフィックス（例: "agp_live_sk_"")
  
  user_id string
  
  このトークンを所有するユーザー
- 成功ブール値
応答属性の非表示応答属性の表示オブジェクト
- count integer
- キー array[オブジェクト]
  
  キー属性を非表示にするキー属性を表示するオブジェクト
  
  created_at string
  
  created_by string
  
  このトークンを作成したユーザー
  
  説明 string
  
  人間が判読できる説明
  
  expires_at string
  
  id string
  
  is_active ブール値
  
  last_used_at string
  
  使用状況の追跡
  
  org_id string
  
  このトークンが属する組織
  
  project_id string
  
  このトークンが属するプロジェクト
  
  revoked_at string
  
  revoked_by string
  
  token_prefix string
  
  識別用の限界のあるルックアップのプレフィックス（例: "agp_live_sk_"")
  
  user_id string
  
  このトークンを所有するユーザー
- 成功ブール値
401

application/ JSON

application/ JSON アプリケーション/vnd.agent- engine-2026-09-20-preview+json

許可されていない
応答属性の非表示応答属性の表示オブジェクト
- コード string
- エラー string
- 成功ブール値
応答属性の非表示応答属性の表示オブジェクト
- コード string
- エラー string
- 成功ブール値
500

application/ JSON

application/ JSON アプリケーション/vnd.agent- engine-2026-09-20-preview+json

内部サーバーエラー
応答属性の非表示応答属性の表示オブジェクト
- コード string
- エラー string
- 成功ブール値
応答属性の非表示応答属性の表示オブジェクト
- コード string
- エラー string
- 成功ブール値

GET /api/v1 /projects/{id}/keys

curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/keys' \
 --header "Authorization: $API_KEY"

応答の例（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）

{
  "count": 42,
  "keys": [
    {
      "created_at": "string",
      "created_by": "string",
      "description": "string",
      "expires_at": "string",
      "id": "string",
      "is_active": true,
      "last_used_at": "string",
      "org_id": "string",
      "project_id": "string",
      "revoked_at": "string",
      "revoked_by": "string",
      "token_prefix": "string",
      "user_id": "string"
    }
  ],
  "success": true
}

応答の例（200）

{
  "count": 42,
  "keys": [
    {
      "created_at": "string",
      "created_by": "string",
      "description": "string",
      "expires_at": "string",
      "id": "string",
      "is_active": true,
      "last_used_at": "string",
      "org_id": "string",
      "project_id": "string",
      "revoked_at": "string",
      "revoked_by": "string",
      "token_prefix": "string",
      "user_id": "string"
    }
  ],
  "success": true
}

応答の例（401）

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

応答の例（401）

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

応答の例（500）

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

応答の例（500）

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

API キーを一覧表示する

path パラメータ

クエリ パラメータ

応答

クエリパラメータ