AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

1 つのエージェント API キーを作成

ベース URL: https://cloud.mongodb.com/api/public/v1.0

POST /groups/{PROJECT-ID}/agentapikeys

このエンドポイントは、 Project Ownerロールを持つユーザーに制限されています。

名前
タイプ
説明

プロジェクトID

string

エージェント API キーを所有するプロジェクトの一意の識別子。

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

レスポンス本体をpretty-print形式にするかどうかを示すフラグ。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

false

名前
タイプ
説明

desc

string

このエージェント API キーのラベル。

名前
タイプ
説明

id

string

このエージェント API キーの一意の識別子。

キー

string

エージェント API キー。

このエージェント API キーを作成すると、後続のリクエストによってエージェント API キーの最後の 4 文字が返されます。

desc

string

このエージェント API キーのラベル。 1,000 文字に制限されます。

createdTime

string

エージェント API キーが作成されたときのISO 8601の日付と時刻形式(UTC)のタイムスタンプ。

createdUserId

string

このエージェント API キーを作成したユーザーの一意の識別子。

createdIpAddr

string

このエージェント API キーを作成したIPアドレス。

createdBy

string

このエージェント API キーのソース。 指定できる値は以下のとおりです。

  • USER

  • OLD_KEY

  • PROVISIONING

  • ATLAS

  • PUBLIC_API

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agentapikeys?pretty=true" \ --data ' { "desc": "Agent API Key for this project" }'
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{ "_id" : "{AGENT-API-KEY-ID}", "createdBy" : "PUBLIC_API", "createdIpAddr" : "{IP-ADDRESS}", "createdTime" : 1520458807291, "createdUserId" : "{USER-ID}", "desc" : "Agent API Key for this project", "key" : "{AGENT-API-KEY}"}